kubernetes-fluent-client 0.0.0-development

package/src/types.ts

@@ -0,0 +1,186 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+
+import { KubernetesListObject, KubernetesObject, V1ObjectMeta } from "@kubernetes/client-node";
+
+export { KubernetesListObject, KubernetesObject };
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type GenericClass = abstract new () => any;
+
+export enum Operation {
+  CREATE = "CREATE",
+  UPDATE = "UPDATE",
+  DELETE = "DELETE",
+  CONNECT = "CONNECT",
+}
+
+/**
+ * GenericKind is a generic Kubernetes object that can be used to represent any Kubernetes object
+ * that is not explicitly supported. This can be used on its own or as a base class for
+ * other types.
+ */
+export class GenericKind implements KubernetesObject {
+  apiVersion?: string;
+  kind?: string;
+  metadata?: V1ObjectMeta;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string]: any;
+}
+
+/**
+ * GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion
+ * to avoid automatic coercion. It doesn't use a GroupVersion to avoid custom marshalling
+ **/
+export interface GroupVersionKind {
+  /** The K8s resource kind, e..g "Pod". */
+  readonly kind: string;
+  readonly group: string;
+  readonly version?: string;
+  /** Optional, override the plural name for use in Webhook rules generation */
+  readonly plural?: 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 Request<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`.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  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;
+  };
+}
+
+// Special types to handle the recursive keyof typescript lookup
+type Join<K, P> = K extends string | number
+  ? P extends string | number
+    ? `${K}${"" extends P ? "" : "."}${P}`
+    : never
+  : never;
+
+export type Paths<T, D extends number = 10> = [D] extends [never]
+  ? never
+  : T extends object
+  ? { [K in keyof T]-?: K extends string | number ? `${K}` | Join<K, Paths<T[K]>> : never }[keyof T]
+  : "";

package/src/upstream.ts

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+
+/** a is a collection of K8s types to be used within an action: `When(a.Configmap)` */
+export {
+  CoreV1Event as Event,
+  V1APIService as APIService,
+  V1CertificateSigningRequest as CertificateSigningRequest,
+  V1ClusterRole as ClusterRole,
+  V1ClusterRoleBinding as ClusterRoleBinding,
+  V1ConfigMap as ConfigMap,
+  V1ControllerRevision as ControllerRevision,
+  V1CronJob as CronJob,
+  V1CSIDriver as CSIDriver,
+  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,
+  V1Role as Role,
+  V1RoleBinding as RoleBinding,
+  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";
+
+export { GenericKind } from "./types";

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "lib": ["ES2022"],
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "outDir": "dist",
+    "resolveJsonModule": true,
+    "rootDir": "src",
+    "strict": true,
+    "target": "ES2022",
+    "useUnknownInCatchVariables": false
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}