kubernetypes 0.0.0 → 1.35.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2026 Mateusz Paduszyński
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,47 @@
+# `kubernetypes`
+
+![NPM Version](https://img.shields.io/npm/v/kubernetypes)
+![NPM License](https://img.shields.io/npm/l/kubernetypes)
+
+TypeScript types for core Kubernetes APIs.
+
+## Installation
+
+For latest Kubernetes version:
+
+```shell
+npm install kubernetypes
+```
+
+For specific Kubernetes version:
+
+```shell
+npm install kubernetypes@<k8s version>
+```
+
+## Usage
+
+```typescript
+import type { Pod } from 'kubernetypes/api/core/v1';
+
+export default {
+  apiVersion: 'v1',
+  kind: 'Pod',
+  metadata: {
+    name: 'foobar',
+  },
+  spec: {
+    containers: [
+      {
+        name: 'app',
+        image: 'alpine:latest',
+        /* ... */
+      },
+    ],
+  },
+} satisfies Pod;
+```
+
+## License
+
+MIT

package/dist/api/admission/v1.d.ts

@@ -0,0 +1,163 @@
+import * as m2 from 'kubernetypes/api/authentication/v1';
+import * as m1 from 'kubernetypes/apimachinery/apis/meta/v1';
+import * as m3 from 'kubernetypes/apimachinery/runtime';
+import * as m0 from 'kubernetypes/apimachinery/types';
+/**
+ * AdmissionRequest describes the admission.Attributes for the admission request.
+ */
+export type AdmissionRequest = {
+    /**
+     * dryRun indicates that modifications will definitely not be persisted for this request.
+     * Defaults to false.
+     */
+    'dryRun'?: boolean;
+    /**
+     * kind is the fully-qualified type of object being submitted (for example, v1.Pod or autoscaling.v1.Scale)
+     */
+    'kind': m1.GroupVersionKind;
+    /**
+     * 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 field will contain an empty string.
+     */
+    'name'?: string;
+    /**
+     * namespace is the namespace associated with the request (if any).
+     */
+    'namespace'?: string;
+    /**
+     * object is the object from the incoming request.
+     */
+    'object'?: m3.RawExtension;
+    /**
+     * oldObject is the existing object. Only populated for DELETE and UPDATE requests.
+     */
+    'oldObject'?: m3.RawExtension;
+    /**
+     * 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.
+     */
+    'operation': Operation;
+    /**
+     * options is the operation option structure of 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`.
+     */
+    'options'?: m3.RawExtension;
+    /**
+     * requestKind is the fully-qualified type of the original API request (for example, v1.Pod or autoscaling.v1.Scale).
+     * If this is specified and differs from the value in "kind", an equivalent match and conversion was performed.
+     *
+     * For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of
+     * `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]` and `matchPolicy: Equivalent`,
+     * an API request to apps/v1beta1 deployments would be converted and sent to the webhook
+     * with `kind: {group:"apps", version:"v1", kind:"Deployment"}` (matching the rule the webhook registered for),
+     * and `requestKind: {group:"apps", version:"v1beta1", kind:"Deployment"}` (indicating the kind of the original API request).
+     *
+     * See documentation for the "matchPolicy" field in the webhook configuration type for more details.
+     */
+    'requestKind'?: m1.GroupVersionKind;
+    /**
+     * requestResource is the fully-qualified resource of the original API request (for example, v1.pods).
+     * If this is specified and differs from the value in "resource", an equivalent match and conversion was performed.
+     *
+     * For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of
+     * `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]` and `matchPolicy: Equivalent`,
+     * an API request to apps/v1beta1 deployments would be converted and sent to the webhook
+     * with `resource: {group:"apps", version:"v1", resource:"deployments"}` (matching the resource the webhook registered for),
+     * and `requestResource: {group:"apps", version:"v1beta1", resource:"deployments"}` (indicating the resource of the original API request).
+     *
+     * See documentation for the "matchPolicy" field in the webhook configuration type.
+     */
+    'requestResource'?: m1.GroupVersionResource;
+    /**
+     * requestSubResource is the name of the subresource of the original API request, if any (for example, "status" or "scale")
+     * If this is specified and differs from the value in "subResource", an equivalent match and conversion was performed.
+     * See documentation for the "matchPolicy" field in the webhook configuration type.
+     */
+    'requestSubResource'?: string;
+    /**
+     * resource is the fully-qualified resource being requested (for example, v1.pods)
+     */
+    'resource': m1.GroupVersionResource;
+    /**
+     * subResource is the subresource being requested, if any (for example, "status" or "scale")
+     */
+    'subResource'?: string;
+    /**
+     * uid is an identifier for the individual request/response. It allows us to distinguish instances of requests which are
+     * otherwise identical (parallel requests, requests when earlier requests did not modify etc)
+     * The UID is meant to track the round trip (request/response) between the KAS and the WebHook, not the user request.
+     * It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging.
+     */
+    'uid': m0.UID;
+    /**
+     * userInfo is information about the requesting user
+     */
+    'userInfo': m2.UserInfo;
+};
+/**
+ * AdmissionResponse describes an admission response.
+ */
+export type AdmissionResponse = {
+    /**
+     * allowed indicates whether or not the admission request was permitted.
+     */
+    'allowed': boolean;
+    /**
+     * auditAnnotations is an unstructured key value map set by remote admission controller (e.g. error=image-blacklisted).
+     * MutatingAdmissionWebhook and ValidatingAdmissionWebhook admission controller will prefix the keys with
+     * admission webhook name (e.g. imagepolicy.example.com/error=image-blacklisted). AuditAnnotations will be provided by
+     * the admission webhook to add additional context to the audit log for this request.
+     */
+    'auditAnnotations'?: {
+        [key: string]: string;
+    };
+    /**
+     * patch is the patch body. Currently we only support "JSONPatch" which implements RFC 6902.
+     */
+    'patch'?: number[];
+    /**
+     * patchType is the type of Patch. Currently we only allow "JSONPatch".
+     */
+    'patchType'?: PatchType;
+    /**
+     * status is the result contains extra details into why an admission request was denied.
+     * This field IS NOT consulted in any way if "Allowed" is "true".
+     */
+    'status'?: m1.Status;
+    /**
+     * uid is an identifier for the individual request/response.
+     * This must be copied over from the corresponding AdmissionRequest.
+     */
+    'uid': m0.UID;
+    /**
+     * warnings is a list of warning messages to return to the requesting API client.
+     * Warning messages describe a problem the client making the API request should correct or be aware of.
+     * Limit warnings to 120 characters if possible.
+     * Warnings over 256 characters and large numbers of warnings may be truncated.
+     */
+    'warnings'?: string[];
+};
+/**
+ * AdmissionReview describes an admission review request/response.
+ */
+export type AdmissionReview = m1.TypeMeta<'admission.k8s.io/v1', 'AdmissionReview'> & {
+    /**
+     * request describes the attributes for the admission request.
+     */
+    'request'?: AdmissionRequest;
+    /**
+     * response describes the attributes for the admission response.
+     */
+    'response'?: AdmissionResponse;
+};
+/**
+ * Operation is the type of resource operation being checked for admission control
+ */
+export type Operation = 'CONNECT' | 'CREATE' | 'DELETE' | 'UPDATE' | (string & {});
+/**
+ * PatchType is the type of patch being used to represent the mutated object
+ */
+export type PatchType = 'JSONPatch' | (string & {});

package/dist/api/admission/v1beta1.d.ts

@@ -0,0 +1,163 @@
+import * as m2 from 'kubernetypes/api/authentication/v1';
+import * as m1 from 'kubernetypes/apimachinery/apis/meta/v1';
+import * as m3 from 'kubernetypes/apimachinery/runtime';
+import * as m0 from 'kubernetypes/apimachinery/types';
+/**
+ * AdmissionRequest describes the admission.Attributes for the admission request.
+ */
+export type AdmissionRequest = {
+    /**
+     * dryRun indicates that modifications will definitely not be persisted for this request.
+     * Defaults to false.
+     */
+    'dryRun'?: boolean;
+    /**
+     * kind is the fully-qualified type of object being submitted (for example, v1.Pod or autoscaling.v1.Scale)
+     */
+    'kind': m1.GroupVersionKind;
+    /**
+     * 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 field will contain an empty string.
+     */
+    'name'?: string;
+    /**
+     * namespace is the namespace associated with the request (if any).
+     */
+    'namespace'?: string;
+    /**
+     * object is the object from the incoming request.
+     */
+    'object'?: m3.RawExtension;
+    /**
+     * oldObject is the existing object. Only populated for DELETE and UPDATE requests.
+     */
+    'oldObject'?: m3.RawExtension;
+    /**
+     * 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.
+     */
+    'operation': Operation;
+    /**
+     * options is the operation option structure of 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`.
+     */
+    'options'?: m3.RawExtension;
+    /**
+     * requestKind is the fully-qualified type of the original API request (for example, v1.Pod or autoscaling.v1.Scale).
+     * If this is specified and differs from the value in "kind", an equivalent match and conversion was performed.
+     *
+     * For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of
+     * `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]` and `matchPolicy: Equivalent`,
+     * an API request to apps/v1beta1 deployments would be converted and sent to the webhook
+     * with `kind: {group:"apps", version:"v1", kind:"Deployment"}` (matching the rule the webhook registered for),
+     * and `requestKind: {group:"apps", version:"v1beta1", kind:"Deployment"}` (indicating the kind of the original API request).
+     *
+     * See documentation for the "matchPolicy" field in the webhook configuration type for more details.
+     */
+    'requestKind'?: m1.GroupVersionKind;
+    /**
+     * requestResource is the fully-qualified resource of the original API request (for example, v1.pods).
+     * If this is specified and differs from the value in "resource", an equivalent match and conversion was performed.
+     *
+     * For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of
+     * `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]` and `matchPolicy: Equivalent`,
+     * an API request to apps/v1beta1 deployments would be converted and sent to the webhook
+     * with `resource: {group:"apps", version:"v1", resource:"deployments"}` (matching the resource the webhook registered for),
+     * and `requestResource: {group:"apps", version:"v1beta1", resource:"deployments"}` (indicating the resource of the original API request).
+     *
+     * See documentation for the "matchPolicy" field in the webhook configuration type.
+     */
+    'requestResource'?: m1.GroupVersionResource;
+    /**
+     * requestSubResource is the name of the subresource of the original API request, if any (for example, "status" or "scale")
+     * If this is specified and differs from the value in "subResource", an equivalent match and conversion was performed.
+     * See documentation for the "matchPolicy" field in the webhook configuration type.
+     */
+    'requestSubResource'?: string;
+    /**
+     * resource is the fully-qualified resource being requested (for example, v1.pods)
+     */
+    'resource': m1.GroupVersionResource;
+    /**
+     * subResource is the subresource being requested, if any (for example, "status" or "scale")
+     */
+    'subResource'?: string;
+    /**
+     * uid is an identifier for the individual request/response. It allows us to distinguish instances of requests which are
+     * otherwise identical (parallel requests, requests when earlier requests did not modify etc)
+     * The UID is meant to track the round trip (request/response) between the KAS and the WebHook, not the user request.
+     * It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging.
+     */
+    'uid': m0.UID;
+    /**
+     * userInfo is information about the requesting user
+     */
+    'userInfo': m2.UserInfo;
+};
+/**
+ * AdmissionResponse describes an admission response.
+ */
+export type AdmissionResponse = {
+    /**
+     * allowed indicates whether or not the admission request was permitted.
+     */
+    'allowed': boolean;
+    /**
+     * auditAnnotations is an unstructured key value map set by remote admission controller (e.g. error=image-blacklisted).
+     * MutatingAdmissionWebhook and ValidatingAdmissionWebhook admission controller will prefix the keys with
+     * admission webhook name (e.g. imagepolicy.example.com/error=image-blacklisted). AuditAnnotations will be provided by
+     * the admission webhook to add additional context to the audit log for this request.
+     */
+    'auditAnnotations'?: {
+        [key: string]: string;
+    };
+    /**
+     * patch is the patch body. Currently we only support "JSONPatch" which implements RFC 6902.
+     */
+    'patch'?: number[];
+    /**
+     * patchType is the type of Patch. Currently we only allow "JSONPatch".
+     */
+    'patchType'?: PatchType;
+    /**
+     * status is the result contains extra details into why an admission request was denied.
+     * This field IS NOT consulted in any way if "Allowed" is "true".
+     */
+    'status'?: m1.Status;
+    /**
+     * uid is an identifier for the individual request/response.
+     * This should be copied over from the corresponding AdmissionRequest.
+     */
+    'uid': m0.UID;
+    /**
+     * warnings is a list of warning messages to return to the requesting API client.
+     * Warning messages describe a problem the client making the API request should correct or be aware of.
+     * Limit warnings to 120 characters if possible.
+     * Warnings over 256 characters and large numbers of warnings may be truncated.
+     */
+    'warnings'?: string[];
+};
+/**
+ * AdmissionReview describes an admission review request/response.
+ */
+export type AdmissionReview = m1.TypeMeta<'admission.k8s.io/v1beta1', 'AdmissionReview'> & {
+    /**
+     * request describes the attributes for the admission request.
+     */
+    'request'?: AdmissionRequest;
+    /**
+     * response describes the attributes for the admission response.
+     */
+    'response'?: AdmissionResponse;
+};
+/**
+ * Operation is the type of resource operation being checked for admission control
+ */
+export type Operation = 'CONNECT' | 'CREATE' | 'DELETE' | 'UPDATE' | (string & {});
+/**
+ * PatchType is the type of patch being used to represent the mutated object
+ */
+export type PatchType = 'JSONPatch' | (string & {});