pepr 0.3.0-rc0 → 0.3.1

package/dist/src/lib/k8s/kinds.test.js

@@ -1,296 +0,0 @@
-"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 });
-const ava_1 = __importDefault(require("ava"));
-const _1 = require(".");
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1APIService'", t => {
-    const { name } = _1.a.APIService;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "apiregistration.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "APIService");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1CertificateSigningRequest'", t => {
-    const { name } = _1.a.CertificateSigningRequest;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "certificates.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "CertificateSigningRequest");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1ConfigMap'", t => {
-    const { name } = _1.a.ConfigMap;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "ConfigMap");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1ControllerRevision'", t => {
-    const { name } = _1.a.ControllerRevision;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "apps");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "ControllerRevision");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1CronJob'", t => {
-    const { name } = _1.a.CronJob;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "batch");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "CronJob");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1CSIDriver'", t => {
-    const { name } = _1.a.CSIDriver;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "storage.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "CSIDriver");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1CSIStorageCapacity'", t => {
-    const { name } = _1.a.CSIStorageCapacity;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "storage.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "CSIStorageCapacity");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1CustomResourceDefinition'", t => {
-    const { name } = _1.a.CustomResourceDefinition;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "apiextensions.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "CustomResourceDefinition");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1DaemonSet'", t => {
-    const { name } = _1.a.DaemonSet;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "apps");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "DaemonSet");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1Deployment'", t => {
-    const { name } = _1.a.Deployment;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "apps");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "Deployment");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1EndpointSlice'", t => {
-    const { name } = _1.a.EndpointSlice;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "discovery.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "EndpointSlice");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1HorizontalPodAutoscaler'", t => {
-    const { name } = _1.a.HorizontalPodAutoscaler;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "autoscaling");
-    t.is(gvk.version, "v2");
-    t.is(gvk.kind, "HorizontalPodAutoscaler");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1Ingress'", t => {
-    const { name } = _1.a.Ingress;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "networking.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "Ingress");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1IngressClass'", t => {
-    const { name } = _1.a.IngressClass;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "networking.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "IngressClass");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1Job'", t => {
-    const { name } = _1.a.Job;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "batch");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "Job");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1LimitRange'", t => {
-    const { name } = _1.a.LimitRange;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "LimitRange");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1LocalSubjectAccessReview'", t => {
-    const { name } = _1.a.LocalSubjectAccessReview;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "authorization.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "LocalSubjectAccessReview");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1MutatingWebhookConfiguration'", t => {
-    const { name } = _1.a.MutatingWebhookConfiguration;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "admissionregistration.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "MutatingWebhookConfiguration");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1Namespace'", t => {
-    const { name } = _1.a.Namespace;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "Namespace");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1NetworkPolicy'", t => {
-    const { name } = _1.a.NetworkPolicy;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "networking.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "NetworkPolicy");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1Node'", t => {
-    const { name } = _1.a.Node;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "Node");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1PersistentVolume'", t => {
-    const { name } = _1.a.PersistentVolume;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "PersistentVolume");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1PersistentVolumeClaim'", t => {
-    const { name } = _1.a.PersistentVolumeClaim;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "PersistentVolumeClaim");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1Pod'", t => {
-    const { name } = _1.a.Pod;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "Pod");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1PodDisruptionBudget'", t => {
-    const { name } = _1.a.PodDisruptionBudget;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "policy");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "PodDisruptionBudget");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1PodTemplate'", t => {
-    const { name } = _1.a.PodTemplate;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "PodTemplate");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1ReplicaSet'", t => {
-    const { name } = _1.a.ReplicaSet;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "apps");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "ReplicaSet");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1ReplicationController'", t => {
-    const { name } = _1.a.ReplicationController;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "ReplicationController");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1ResourceQuota'", t => {
-    const { name } = _1.a.ResourceQuota;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "ResourceQuota");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1RuntimeClass'", t => {
-    const { name } = _1.a.RuntimeClass;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "node.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "RuntimeClass");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1Secret'", t => {
-    const { name } = _1.a.Secret;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "Secret");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1SelfSubjectAccessReview'", t => {
-    const { name } = _1.a.SelfSubjectAccessReview;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "authorization.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "SelfSubjectAccessReview");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1SelfSubjectRulesReview'", t => {
-    const { name } = _1.a.SelfSubjectRulesReview;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "authorization.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "SelfSubjectRulesReview");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1Service'", t => {
-    const { name } = _1.a.Service;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "Service");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1ServiceAccount'", t => {
-    const { name } = _1.a.ServiceAccount;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "ServiceAccount");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1StatefulSet'", t => {
-    const { name } = _1.a.StatefulSet;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "apps");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "StatefulSet");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1StorageClass'", t => {
-    const { name } = _1.a.StorageClass;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "storage.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "StorageClass");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1SubjectAccessReview'", t => {
-    const { name } = _1.a.SubjectAccessReview;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "authorization.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "SubjectAccessReview");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1TokenReview'", t => {
-    const { name } = _1.a.TokenReview;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "authentication.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "TokenReview");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1ValidatingWebhookConfiguration'", t => {
-    const { name } = _1.a.ValidatingWebhookConfiguration;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "admissionregistration.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "ValidatingWebhookConfiguration");
-});
-(0, ava_1.default)("should return the correct GroupVersionKind for 'a.V1VolumeAttachment'", t => {
-    const { name } = _1.a.VolumeAttachment;
-    const gvk = (0, _1.modelToGroupVersionKind)(name);
-    t.is(gvk.group, "storage.k8s.io");
-    t.is(gvk.version, "v1");
-    t.is(gvk.kind, "VolumeAttachment");
-});

package/dist/src/lib/logger.test.js

@@ -1,64 +0,0 @@
-"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 });
-const ava_1 = __importDefault(require("ava"));
-const logger_1 = require("./logger");
-(0, ava_1.default)("Logger debug logs correctly", t => {
-    const logger = new logger_1.Logger(logger_1.LogLevel.debug); // Create a logger with debug level
-    const message = "Debug message";
-    const consoleLog = console.log; // Store the original console.log function
-    const consoleOutput = [];
-    // Replace console.log with a mock function to capture the output
-    console.log = (output) => {
-        consoleOutput.push(output);
-    };
-    logger.debug(message); // Call the debug method
-    // Check that the output matches the expected value
-    t.true(consoleOutput[0].includes(logger_1.LogLevel[logger_1.LogLevel.debug]));
-    t.true(consoleOutput[0].includes(message));
-    // Restore the original console.log function
-    console.log = consoleLog;
-});
-(0, ava_1.default)("Logger info logs correctly", t => {
-    const logger = new logger_1.Logger(logger_1.LogLevel.info); // Create a logger with info level
-    const message = "Info message";
-    const consoleLog = console.log;
-    const consoleOutput = [];
-    console.log = (output) => {
-        consoleOutput.push(output);
-    };
-    logger.info(message);
-    t.true(consoleOutput[0].includes(logger_1.LogLevel[logger_1.LogLevel.info]));
-    t.true(consoleOutput[0].includes(message));
-    console.log = consoleLog;
-});
-(0, ava_1.default)("Logger warn logs correctly", t => {
-    const logger = new logger_1.Logger(logger_1.LogLevel.warn); // Create a logger with warn level
-    const message = "Warning message";
-    const consoleLog = console.log;
-    const consoleOutput = [];
-    console.log = (output) => {
-        consoleOutput.push(output);
-    };
-    logger.warn(message);
-    t.true(consoleOutput[0].includes(logger_1.LogLevel[logger_1.LogLevel.warn]));
-    t.true(consoleOutput[0].includes(message));
-    console.log = consoleLog;
-});
-(0, ava_1.default)("Logger error logs correctly", t => {
-    const logger = new logger_1.Logger(logger_1.LogLevel.error); // Create a logger with error level
-    const message = "Error message";
-    const consoleLog = console.log;
-    const consoleOutput = [];
-    console.log = (output) => {
-        consoleOutput.push(output);
-    };
-    logger.error(message);
-    t.true(consoleOutput[0].includes(logger_1.LogLevel[logger_1.LogLevel.error]));
-    t.true(consoleOutput[0].includes(message));
-    console.log = consoleLog;
-});

package/docs/.prettierrc.json

@@ -1,13 +0,0 @@
-{
-  "arrowParens": "avoid",
-  "bracketSameLine": false,
-  "bracketSpacing": true,
-  "embeddedLanguageFormatting": "auto",
-  "insertPragma": false,
-  "printWidth": 80,
-  "quoteProps": "as-needed",
-  "requirePragma": false,
-  "semi": true,
-  "tabWidth": 2,
-  "useTabs": false
-}

package/docs/actions.md

@@ -1,58 +0,0 @@
-# CapabilityActions
-
-A CapabilityAction is a discrete set of behaviors defined in a single function that acts on a given Kubernetes GroupVersionKind (GVK) passed in from Kubernetes. CapabilityActions are the atomic operations that are performed on Kubernetes resources by Pepr.
-
-For example, a CapabilityAction could be responsible for adding a specific label to a Kubernetes resource, or for modifying a specific field in a resource's metadata. CapabilityActions can be grouped together within a Capability to provide a more comprehensive set of operations that can be performed on Kubernetes resources.
-
-Let's look at some example CapabilityActions that are included in the `HelloPepr` capability that is created for you when you [`pepr init`](./cli.md#pepr-init):
-
----
-
-In this first example, Pepr is adding a label and annotation to a ConfigMap with tne name `example-1` when it is created. Comments are added to each line to explain in more detail what is happening.
-
-```ts
-// When(a.<Kind>) tells Pepr what K8s GroupVersionKind (GVK) this CapabilityAction should act on.
-When(a.ConfigMap)
-  // Next we tell Pepr to only act on new ConfigMaps that are created.
-  .IsCreated()
-  // Then we tell Pepr to only act on ConfigMaps with the name "example-1".
-  .WithName("example-1")
-  // Then() is where we define the actual behavior of this CapabilityAction.
-  .Then(request => {
-    // The request object is a wrapper around the K8s resource that Pepr is acting on.
-    request
-      // Here we are adding a label to the ConfigMap.
-      .SetLabel("pepr", "was-here")
-      // And here we are adding an annotation.
-      .SetAnnotation("pepr.dev", "annotations-work-too");
-
-    // Note that we are not returning anything here. This is because Pepr is tracking the changes in each CapabilityAction automatically.
-  });
-```
-
----
-
-This example is identical to the previous one, except we are acting on a different CongigMap name and using the `ThenSet()` shorthand to merge changes into the resource.
-
-```ts
-// Once again, we tell Pepr what K8s GVK this CapabilityAction should act on.
-When(a.ConfigMap)
-  // Next we tell Pepr to only act on new ConfigMaps that are created.
-  .IsCreated()
-  // This time we are acting on a ConfigMap with the name "example-2".
-  .WithName("example-2")
-  // Instead of using Then(), we are using ThenSet() to merge changes into the resource without a function call.
-  .ThenSet({
-    // Using Typescript, we will get intellisense for the ConfigMap object and immediate type-validation for the values we are setting.
-    metadata: {
-      labels: {
-        pepr: "was-here",
-      },
-      annotations: {
-        "pepr.dev": "annotations-work-too",
-      },
-    },
-  });
-```
-
-There are many more examples in the `HelloPepr` capability that you can use as a reference when creating your own CapabilityActions. Note that each time you run [`pepr update`](./cli.md#pepr-update), Pepr will automatically update the `HelloPepr` capability with the latest examples and best practices for you to reference and test directly in your Pepr Module.

package/docs/capabilities.md

@@ -1,17 +0,0 @@
-# Capabilities
-
-A capability is set of related [CapabilityActions](./actions.md) that work together to achieve a specific transformation or operation on Kubernetes resources. Capabilities are user-defined and can include one or more CapabilityActions. They are defined within a Pepr module and can be used in both MutatingWebhookConfigurations and ValidatingWebhookConfigurations. A Capability can have a specific scope, such as mutating or validating, and can be reused in multiple Pepr modules.
-
-When you [`pepr init`](./cli.md#pepr-init), a `capabilities` directory is created for you. This directory is where you will define your capabilities. You can create as many capabilities as you need, and each capability can contain one or more CapabilityActions. Pepr also automatically creates a `HelloPepr` capability with a number of example CapabilityActions to help you get started.
-
-## Creating a Capability
-
-Define a new capability can be done via a [VSCode Snippet](https://code.visualstudio.com/docs/editor/userdefinedsnippets) generated during [`pepr init`](./cli.md#pepr-init).
-
-1. Create a new file in the `capabilities` directory with the name of your capability. For example, `capabilities/my-capability.ts`.
-
-1. Open the new file in VSCode and type `create` in the file. A suggestion should prompt you to generate the content from there.
-
-https://user-images.githubusercontent.com/882485/230897379-0bb57dff-9832-479f-8733-79e103703135.mp4
-
-_If you prefer not to use VSCode, you can also modify or copy the `HelloPepr` capability to meet your needs instead._

package/docs/cli.md

@@ -1,58 +0,0 @@
-# Pepr CLI
-
-## `pepr init`
-
-Initialize a new Pepr Module.
-
-**Options:**
-
-- `-l, --log-level [level]` - Log level: debug, info, warn, error (default: "info")
-- `--skip-post-init` - Skip npm install, git init and VSCode launch
-
----
-
-## `pepr update`
-
-Update the current Pepr Module to the latest SDK version and update the global Pepr CLI to the same version.
-
-**Options:**
-
-- `-l, --log-level [level]` - Log level: debug, info, warn, error (default: "info")
-- `--skip-template-update` - Skip updating the template files
-
----
-
-## `pepr dev`
-
-Connect a local cluster to a local version of the Pepr Controller to do real-time debugging of your module. Note
-the `pepr dev` assumes a K3d cluster is running by default. If you are working with Kind or another docker-based
-K8s distro, you will need to pass the `--host host.docker.internal` option to `pepr dev`. If working with a remote
-cluster you will have to give Pepr a host path to your machine that is reachable from the K8s cluster.
-
-**Options:**
-
-- `-l, --log-level [level]` - Log level: debug, info, warn, error (default: "info")
-- `-h, --host [host]` - Host to listen on (default: "host.k3d.internal")
-- `--confirm` - Skip confirmation prompt
-
----
-
-## `pepr deploy`
-
-Deploy the current module into a Kubernetes cluster, useful for CI systems. Not recommended for production use.
-
-**Options:**
-
-- `-l, --log-level [level]` - Log level: debug, info, warn, error (default: "info")
-- `-i, --image [image]` - Override the image tag
-- `--confirm` - Skip confirmation prompt
-
----
-
-## `pepr build`
-
-Create a [zarf.yaml](https://zarf.dev) and K8s manifest for the current module. This includes everything needed to deploy Pepr and the current module into production environments.
-
-**Options:**
-
-- `-l, --log-level [level]` - Log level: debug, info, warn, error (default: "info")

package/docs/module.md

@@ -1,90 +0,0 @@
-# Pepr Module
-
-Each Pepr Module is it's own Typescript project, produced by [`pepr init`](./cli.md#pepr-init). Typically a module is maintained by a unique group or system. For example, a module for internal [Zarf](https://zarf.dev/) mutations would be different from a module for [Big Bang](https://p1.dso.mil/products/big-bang). An important idea with modules is that they are _wholly independent of one another_. This means that 2 different modules can be on completely different versions of Pepr and any other dependencies; their only interaction is through the standard K8s interfaces like any other webhook or controller.
-
-## Module development lifecycle
-
-1. **Create the module**:
-
-   Use [`pepr init`](./cli.md#pepr-init) to generate a new module.
-
-1. **Quickly validate system setup**:
-
-   Every new module includes a sample Pepr Capability called `HelloPepr`. By default,
-   this capability is deployed and monitoring the `pepr-demo` namespace. There is a sample
-   yaml also included you can use to see Pepr in your cluster. Here's the quick steps to do
-   that after `pepr init`:
-
-   ```bash
-   # cd to the newly-created Pepr module folder
-   cd my-module-name
-
-   # If you don't already have a local K8s cluster, you can set one up with k3d
-   npm run k3d-setup
-
-   # Launch pepr dev mode (npm start or pepr dev)
-   # If using another local K8s distro instead of k3d, use `pepr dev --host host.docker.internal`
-   pepr dev
-
-   # From another terminal, apply the sample yaml
-   kubectl apply -f capabilities/hello-pepr.samples.yaml
-
-   # Verify the configmaps were transformed using kubectl, k9s or another tool
-   ```
-
-1. **Create your custom Pepr Capabilities**
-
-   Now that you have confirmed Pepr is working, you can now create new [capabilities](./capabilities.md). You'll also want to disable the `HelloPepr` capability in your module (`pepr.ts`) before pushing to production. You can disable by commenting out or deleting the `HelloPepr` variable below:
-
-   ```typescript
-   new PeprModule(cfg, [
-     // Remove or comment the line below to disable the HelloPepr capability
-     HelloPepr,
-
-     // Your additional capabilities go here
-   ]);
-   ```
-
-   _Note: if you also delete the `capabilities/hello-pepr.ts` file, it will be added again on the next [`pepr update`](./cli.md#pepr-update) so you have the latest examples usages from the Pepr SDK. Therefore, it is sufficient to remove the entry from your `pepr.ts` module
-   config._
-
-1. **Build and deploy the Pepr Module**
-
-   Most of the time, you'll likely be iterating on a module with `perp dev` for real-time feedback and validation Once you are ready to move beyond the local dev environment, Pepr provides deployment and build tools you can use.
-
-   `pepr deploy` - you can use this command to build your module and deploy it into any K8s cluster your current `kubecontext` has access to. This setup is ideal for CI systems during testing, but is not recommended for production use. See [`pepr deploy`](./cli.md#pepr-deploy) for more info.
-
-## Advanced Module Configuration
-
-By default, when you run `pepr init`, the module is not configured with any additional options. Currently, there are 3 options you can configure:
-
-- `deferStart` - if set to `true`, the module will not start automatically. You will need to call `start()` manually. This is useful if you want to do some additional setup before the module controller starts. You can also use this to change the default port that the controller listens on.
-
-- `beforeHook` - an optional callback that will be called before every request is processed. This is useful if you want to do some additional logging or validation before the request is processed.
-
-- `afterHook` - an optional callback that will be called after every request is processed. This is useful if you want to do some additional logging or validation after the request is processed.
-
-You can configure each of these by modifying the `pepr.ts` file in your module. Here's an example of how you would configure each of these options:
-
-```typescript
-const module = new PeprModule(
-  cfg,
-  [
-    // Your capabilities go here
-  ],
-  {
-    deferStart: true,
-
-    beforeHook: req => {
-      // Any actions you want to perform before the request is processed, including modifying the request.
-    },
-
-    afterHook: res => {
-      // Any actions you want to perform after the request is processed, including modifying the response.
-    },
-  }
-);
-
-// Do any additional setup before starting the controller
-module.start();
-```

package/osv-scanner.toml

@@ -1,4 +0,0 @@
-# One entry for each vulnerability group
-[[IgnoredVulns]]
-id = "GHSA-p8p7-x288-28g6"
-reason = "Library only used client-side and not affected by this vulnerability."