pepr 0.31.1 → 0.32.0

package/dist/lib/k8s.d.ts

@@ -1,132 +0,0 @@
-import { GenericKind, GroupVersionKind, KubernetesObject } from "kubernetes-fluent-client";
-export declare enum Operation {
-    CREATE = "CREATE",
-    UPDATE = "UPDATE",
-    DELETE = "DELETE",
-    CONNECT = "CONNECT"
-}
-/**
- * PeprStore for internal use by Pepr. This is used to store arbitrary data in the cluster.
- */
-export declare class PeprStore extends GenericKind {
-    data: {
-        [key: string]: string;
-    };
-}
-export declare const peprStoreGVK: {
-    kind: string;
-    version: string;
-    group: string;
-};
-/**
- * GroupVersionResource unambiguously identifies a resource. It doesn't anonymously include GroupVersion
- * to avoid automatic coercion. It doesn't use a GroupVersion to avoid custom marshalling
- */
-export interface GroupVersionResource {
-    readonly group: string;
-    readonly version: string;
-    readonly resource: string;
-}
-/**
- * A Kubernetes admission request to be processed by a capability.
- */
-export interface AdmissionRequest<T = KubernetesObject> {
-    /** UID is an identifier for the individual request/response. */
-    readonly uid: string;
-    /** Kind is the fully-qualified type of object being submitted (for example, v1.Pod or autoscaling.v1.Scale) */
-    readonly kind: GroupVersionKind;
-    /** Resource is the fully-qualified resource being requested (for example, v1.pods) */
-    readonly resource: GroupVersionResource;
-    /** SubResource is the sub-resource being requested, if any (for example, "status" or "scale") */
-    readonly subResource?: string;
-    /** RequestKind is the fully-qualified type of the original API request (for example, v1.Pod or autoscaling.v1.Scale). */
-    readonly requestKind?: GroupVersionKind;
-    /** RequestResource is the fully-qualified resource of the original API request (for example, v1.pods). */
-    readonly requestResource?: GroupVersionResource;
-    /** RequestSubResource is the sub-resource of the original API request, if any (for example, "status" or "scale"). */
-    readonly requestSubResource?: string;
-    /**
-     * Name is the name of the object as presented in the request. On a CREATE operation, the client may omit name and
-     * rely on the server to generate the name. If that is the case, this method will return the empty string.
-     */
-    readonly name: string;
-    /** Namespace is the namespace associated with the request (if any). */
-    readonly namespace?: string;
-    /**
-     * Operation is the operation being performed. This may be different than the operation
-     * requested. e.g. a patch can result in either a CREATE or UPDATE Operation.
-     */
-    readonly operation: Operation;
-    /** UserInfo is information about the requesting user */
-    readonly userInfo: {
-        /** The name that uniquely identifies this user among all active users. */
-        username?: string;
-        /**
-         * A unique value that identifies this user across time. If this user is deleted
-         * and another user by the same name is added, they will have different UIDs.
-         */
-        uid?: string;
-        /** The names of groups this user is a part of. */
-        groups?: string[];
-        /** Any additional information provided by the authenticator. */
-        extra?: {
-            [key: string]: string[];
-        };
-    };
-    /** Object is the object from the incoming request prior to default values being applied */
-    readonly object: T;
-    /** OldObject is the existing object. Only populated for UPDATE or DELETE requests. */
-    readonly oldObject?: T;
-    /** DryRun indicates that modifications will definitely not be persisted for this request. Defaults to false. */
-    readonly dryRun?: boolean;
-    /**
-     * Options contains the options for the operation being performed.
-     * e.g. `meta.k8s.io/v1.DeleteOptions` or `meta.k8s.io/v1.CreateOptions`. This may be
-     * different than the options the caller provided. e.g. for a patch request the performed
-     * Operation might be a CREATE, in which case the Options will a
-     * `meta.k8s.io/v1.CreateOptions` even though the caller provided `meta.k8s.io/v1.PatchOptions`.
-     */
-    readonly options?: any;
-}
-export interface MutateResponse {
-    /** UID is an identifier for the individual request/response. This must be copied over from the corresponding AdmissionRequest. */
-    uid: string;
-    /** Allowed indicates whether or not the admission request was permitted. */
-    allowed: boolean;
-    /** Result contains extra details into why an admission request was denied. This field IS NOT consulted in any way if "Allowed" is "true". */
-    result?: string;
-    /** The patch body. Currently we only support "JSONPatch" which implements RFC 6902. */
-    patch?: string;
-    /** The type of Patch. Currently we only allow "JSONPatch". */
-    patchType?: "JSONPatch";
-    /**
-     * AuditAnnotations is an unstructured key value map set by remote admission controller (e.g. error=image-blacklisted).
-     *
-     * See https://kubernetes.io/docs/reference/labels-annotations-taints/audit-annotations/ for more information
-     */
-    auditAnnotations?: {
-        [key: string]: string;
-    };
-    /** warnings is a list of warning messages to return to the requesting API client. */
-    warnings?: string[];
-}
-export interface ValidateResponse extends MutateResponse {
-    /** Status contains extra details into why an admission request was denied. This field IS NOT consulted in any way if "Allowed" is "true". */
-    status?: {
-        /** A machine-readable description of why this operation is in the
-             "Failure" status. If this value is empty there is no information available. */
-        code: number;
-        /** A human-readable description of the status of this operation. */
-        message: string;
-    };
-}
-export type WebhookIgnore = {
-    /**
-     * List of Kubernetes namespaces to always ignore.
-     * Any resources in these namespaces will be ignored by Pepr.
-     *
-     * Note: `kube-system` and `pepr-system` are always ignored.
-     */
-    namespaces?: string[];
-};
-//# sourceMappingURL=k8s.d.ts.map

package/dist/lib/logger.d.ts

@@ -1,3 +0,0 @@
-declare const Log: import("pino").Logger<never>;
-export default Log;
-//# sourceMappingURL=logger.d.ts.map

package/dist/lib/metrics.d.ts

@@ -1,39 +0,0 @@
-/**
- * MetricsCollector class handles metrics collection using prom-client and performance hooks.
- */
-export declare class MetricsCollector {
-    #private;
-    /**
-     * Creates a MetricsCollector instance with prefixed metrics.
-     * @param [prefix='pepr'] - The prefix for the metric names.
-     */
-    constructor(prefix?: string);
-    addCounter: (name: string, help: string) => void;
-    addSummary: (name: string, help: string) => void;
-    incCounter: (name: string) => void;
-    /**
-     * Increments the error counter.
-     */
-    error: () => void;
-    /**
-     * Increments the alerts counter.
-     */
-    alert: () => void;
-    /**
-     * Observes the duration since the provided start time and updates the summary.
-     * @param startTime - The start time.
-     * @param name - The metrics summary to increment.
-     */
-    observeEnd: (startTime: number, name?: string) => void;
-    /**
-     * Fetches the current metrics from the registry.
-     * @returns The metrics.
-     */
-    getMetrics: () => Promise<string>;
-    /**
-     * Returns the current timestamp from performance.now() method. Useful for start timing an operation.
-     * @returns The timestamp.
-     */
-    static observeStart(): number;
-}
-//# sourceMappingURL=metrics.d.ts.map

package/dist/lib/module.d.ts

@@ -1,62 +0,0 @@
-import { Capability } from "./capability";
-import { AdmissionRequest, MutateResponse, ValidateResponse, WebhookIgnore } from "./k8s";
-/** Custom Labels Type for package.json */
-export interface CustomLabels {
-    namespace?: Record<string, string>;
-}
-/** Global configuration for the Pepr runtime. */
-export type ModuleConfig = {
-    /** The Pepr version this module uses */
-    peprVersion?: string;
-    /** The user-defined version of the module */
-    appVersion?: string;
-    /** A unique identifier for this Pepr module. This is automatically generated by Pepr. */
-    uuid: string;
-    /** A description of the Pepr module and what it does. */
-    description?: string;
-    /** The webhookTimeout */
-    webhookTimeout?: number;
-    /** Reject K8s resource AdmissionRequests on error. */
-    onError?: string;
-    /** Configure global exclusions that will never be processed by Pepr. */
-    alwaysIgnore: WebhookIgnore;
-    /** Define the log level for the in-cluster controllers */
-    logLevel?: string;
-    /** Propagate env variables to in-cluster controllers */
-    env?: Record<string, string>;
-    /** Custom Labels for Kubernetes Objects */
-    customLabels?: CustomLabels;
-};
-export type PackageJSON = {
-    description: string;
-    pepr: ModuleConfig;
-};
-export type PeprModuleOptions = {
-    deferStart?: boolean;
-    /** A user-defined callback to pre-process or intercept a Pepr request from K8s immediately before it is processed */
-    beforeHook?: (req: AdmissionRequest) => void;
-    /** A user-defined callback to post-process or intercept a Pepr response just before it is returned to K8s */
-    afterHook?: (res: MutateResponse | ValidateResponse) => void;
-};
-export declare const isWatchMode: () => boolean;
-export declare const isBuildMode: () => boolean;
-export declare const isDevMode: () => boolean;
-export declare class PeprModule {
-    #private;
-    /**
-     * Create a new Pepr runtime
-     *
-     * @param config The configuration for the Pepr runtime
-     * @param capabilities The capabilities to be loaded into the Pepr runtime
-     * @param opts Options for the Pepr runtime
-     */
-    constructor({ description, pepr }: PackageJSON, capabilities?: Capability[], opts?: PeprModuleOptions);
-    /**
-     * Start the Pepr runtime manually.
-     * Normally this is called automatically when the Pepr module is instantiated, but can be called manually if `deferStart` is set to `true` in the constructor.
-     *
-     * @param port
-     */
-    start: (port?: number) => void;
-}
-//# sourceMappingURL=module.d.ts.map

package/dist/lib/mutate-processor.d.ts

@@ -1,5 +0,0 @@
-import { Capability } from "./capability";
-import { MutateResponse, AdmissionRequest } from "./k8s";
-import { ModuleConfig } from "./module";
-export declare function mutateProcessor(config: ModuleConfig, capabilities: Capability[], req: AdmissionRequest, reqMetadata: Record<string, string>): Promise<MutateResponse>;
-//# sourceMappingURL=mutate-processor.d.ts.map

package/dist/lib/mutate-request.d.ts

@@ -1,79 +0,0 @@
-import { KubernetesObject } from "kubernetes-fluent-client";
-import { AdmissionRequest } from "./k8s";
-import { DeepPartial } from "./types";
-/**
- * The RequestWrapper class provides methods to modify Kubernetes objects in the context
- * of a mutating webhook request.
- */
-export declare class PeprMutateRequest<T extends KubernetesObject> {
-    #private;
-    Raw: T;
-    get PermitSideEffects(): boolean;
-    /**
-     * Indicates whether the request is a dry run.
-     * @returns true if the request is a dry run, false otherwise.
-     */
-    get IsDryRun(): boolean | undefined;
-    /**
-     * Provides access to the old resource in the request if available.
-     * @returns The old Kubernetes resource object or null if not available.
-     */
-    get OldResource(): T | undefined;
-    /**
-     * Provides access to the request object.
-     * @returns The request object containing the Kubernetes resource.
-     */
-    get Request(): AdmissionRequest<T>;
-    /**
-     * Creates a new instance of the action class.
-     * @param input - The request object containing the Kubernetes resource to modify.
-     */
-    constructor(input: AdmissionRequest<T>);
-    /**
-     * Deep merges the provided object with the current resource.
-     *
-     * @param obj - The object to merge with the current resource.
-     */
-    Merge: (obj: DeepPartial<T>) => void;
-    /**
-     * Updates a label on the Kubernetes resource.
-     * @param key - The key of the label to update.
-     * @param value - The value of the label.
-     * @returns The current action instance for method chaining.
-     */
-    SetLabel: (key: string, value: string) => this;
-    /**
-     * Updates an annotation on the Kubernetes resource.
-     * @param key - The key of the annotation to update.
-     * @param value - The value of the annotation.
-     * @returns The current action instance for method chaining.
-     */
-    SetAnnotation: (key: string, value: string) => this;
-    /**
-     * Removes a label from the Kubernetes resource.
-     * @param key - The key of the label to remove.
-     * @returns The current Action instance for method chaining.
-     */
-    RemoveLabel: (key: string) => this;
-    /**
-     * Removes an annotation from the Kubernetes resource.
-     * @param key - The key of the annotation to remove.
-     * @returns The current Action instance for method chaining.
-     */
-    RemoveAnnotation: (key: string) => this;
-    /**
-     * Check if a label exists on the Kubernetes resource.
-     *
-     * @param key the label key to check
-     * @returns
-     */
-    HasLabel: (key: string) => boolean;
-    /**
-     * Check if an annotation exists on the Kubernetes resource.
-     *
-     * @param key the annotation key to check
-     * @returns
-     */
-    HasAnnotation: (key: string) => boolean;
-}
-//# sourceMappingURL=mutate-request.d.ts.map

package/dist/lib/queue.d.ts

@@ -1,19 +0,0 @@
-import { KubernetesObject } from "@kubernetes/client-node";
-import { WatchPhase } from "kubernetes-fluent-client/dist/fluent/types";
-/**
- * Queue is a FIFO queue for reconciling
- */
-export declare class Queue<K extends KubernetesObject> {
-    #private;
-    constructor();
-    setReconcile(reconcile: (obj: KubernetesObject, type: WatchPhase) => Promise<void>): void;
-    /**
-     * Enqueue adds an item to the queue and returns a promise that resolves when the item is
-     * reconciled.
-     *
-     * @param item The object to reconcile
-     * @returns A promise that resolves when the object is reconciled
-     */
-    enqueue(item: K, type: WatchPhase): Promise<void>;
-}
-//# sourceMappingURL=queue.d.ts.map

package/dist/lib/schedule.d.ts

@@ -1,76 +0,0 @@
-/// <reference types="node" />
-import { PeprStore } from "./storage";
-type Unit = "seconds" | "second" | "minute" | "minutes" | "hours" | "hour";
-export interface Schedule {
-    /**
-     * * The name of the store
-     */
-    name: string;
-    /**
-     * The value associated with a unit of time
-     */
-    every: number;
-    /**
-     * The unit of time
-     */
-    unit: Unit;
-    /**
-     * The code to run
-     */
-    run: () => void;
-    /**
-     * The start time of the schedule
-     */
-    startTime?: Date | undefined;
-    /**
-     * The number of times the schedule has run
-     */
-    completions?: number | undefined;
-    /**
-     * Tje intervalID to clear the interval
-     */
-    intervalID?: NodeJS.Timeout;
-}
-export declare class OnSchedule implements Schedule {
-    intervalId: NodeJS.Timeout | null;
-    store: PeprStore | undefined;
-    name: string;
-    completions?: number | undefined;
-    every: number;
-    unit: Unit;
-    run: () => void;
-    startTime?: Date | undefined;
-    duration: number | undefined;
-    lastTimestamp: Date | undefined;
-    constructor(schedule: Schedule);
-    setStore(store: PeprStore): void;
-    startInterval(): void;
-    /**
-     * Checks the store for this schedule and sets the values if it exists
-     * @returns
-     */
-    checkStore(): void;
-    /**
-     * Saves the schedule to the store
-     * @returns
-     */
-    saveToStore(): void;
-    /**
-     * Gets the durations in milliseconds
-     */
-    getDuration(): void;
-    /**
-     * Sets up the interval
-     */
-    setupInterval(): void;
-    /**
-     * Starts the interval
-     */
-    start(): void;
-    /**
-     * Stops the interval
-     */
-    stop(): void;
-}
-export {};
-//# sourceMappingURL=schedule.d.ts.map

package/dist/lib/storage.d.ts

@@ -1,83 +0,0 @@
-export type DataOp = "add" | "remove";
-export type DataStore = Record<string, string>;
-export type DataSender = (op: DataOp, keys: string[], value?: string) => void;
-export type DataReceiver = (data: DataStore) => void;
-export type Unsubscribe = () => void;
-export interface PeprStore {
-    /**
-     * Returns the current value associated with the given key, or null if the given key does not exist.
-     */
-    getItem(key: string): string | null;
-    /**
-     * Removes all key/value pairs, if there are any.
-     */
-    clear(): void;
-    /**
-     * Removes the key/value pair with the given key, if a key/value pair with the given key exists.
-     */
-    removeItem(key: string): void;
-    /**
-     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
-     */
-    setItem(key: string, value: string): void;
-    /**
-     * Subscribe to changes in the store. This API behaves similarly to the [Svelte Store API](https://vercel.com/docs/beginner-sveltekit/svelte-stores#using-the-store).
-     *
-     * @param listener - The callback to be invoked when the store changes.
-     * @returns A function to unsubscribe from the listener.
-     */
-    subscribe(listener: DataReceiver): Unsubscribe;
-    /**
-     * Register a function to be called when the store is ready.
-     */
-    onReady(callback: DataReceiver): void;
-    /**
-     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
-     * Resolves when the key/value show up in the store.
-     */
-    setItemAndWait(key: string, value: string): Promise<void>;
-    /**
-     * Remove the value of the key.
-     * Resolves when the key does not show up in the store.
-     */
-    removeItemAndWait(key: string): Promise<void>;
-}
-/**
- * A key-value data store that can be used to persist data that should be shared across Pepr controllers and capabilities.
- *
- * The API is similar to the [Storage API](https://developer.mozilla.org/docs/Web/API/Storage)
- */
-export declare class Storage implements PeprStore {
-    #private;
-    registerSender: (send: DataSender) => void;
-    receive: (data: DataStore) => void;
-    getItem: (key: string) => string | null;
-    clear: () => void;
-    removeItem: (key: string) => void;
-    setItem: (key: string, value: string) => void;
-    /**
-     * Creates a promise and subscribes to the store, the promise resolves when
-     * the key and value are seen in the store.
-     *
-     * @param key - The key to add into the store
-     * @param value - The value of the key
-     * @returns
-     */
-    setItemAndWait: (key: string, value: string) => Promise<void>;
-    /**
-     * Creates a promise and subscribes to the store, the promise resolves when
-     * the key is removed from the store.
-     *
-     * @param key - The key to add into the store
-     * @returns
-     */
-    removeItemAndWait: (key: string) => Promise<void>;
-    subscribe: (subscriber: DataReceiver) => () => void;
-    onReady: (callback: DataReceiver) => void;
-    /**
-     * Remove a subscriber from the list of subscribers.
-     * @param idx - The index of the subscriber to remove.
-     */
-    unsubscribe: (idx: number) => void;
-}
-//# sourceMappingURL=storage.d.ts.map

package/dist/lib/tls.d.ts

@@ -1,18 +0,0 @@
-export interface TLSOut {
-    ca: string;
-    crt: string;
-    key: string;
-    pem: {
-        ca: string;
-        crt: string;
-        key: string;
-    };
-}
-/**
- * Generates a self-signed CA and server certificate with Subject Alternative Names (SANs) for the K8s webhook.
- *
- * @param {string} name - The name to use for the server certificate's Common Name and SAN DNS entry.
- * @returns {TLSOut} - An object containing the Base64-encoded CA, server certificate, and server private key.
- */
-export declare function genTLS(name: string): TLSOut;
-//# sourceMappingURL=tls.d.ts.map