kubernetesjs 0.7.0 → 0.7.2

package/README.md

@@ -13,8 +13,12 @@
   </a>
 </p>
 
+KubernetesJS is a **fully-typed**, zero-dependency TypeScript client for Kubernetes.
+
+Write infrastructure like you write apps—modular, composable, and testable. KubernetesJS gives you direct, programmatic access to the entire Kubernetes API, with the developer experience of modern JavaScript tooling.
+
+> No more brittle YAML. No more hidden chart logic. Just pure, type-safe Kubernetes from the language you already use.
 
-KubernetesJS is a **fully-typed**, zero-dependency TypeScript library designed to simplify interactions with Kubernetes APIs. With comprehensive TypeScript support, it provides a strongly-typed interface that makes managing Kubernetes resources clear and predictable, ideal for TypeScript developers looking to integrate Kubernetes management into their applications.
 
 ## Features
 
@@ -23,6 +27,8 @@ KubernetesJS is a **fully-typed**, zero-dependency TypeScript library designed t
 - **📡 Full Kubernetes API Coverage**: Supports all Kubernetes API endpoints with detailed TypeScript types.
 - **🌐 Cross-Platform**: Works with both Node.js and browser environments.
 
+With KubernetesJS, you don’t shell out to `kubectl`, grep logs, or decode YAML trees. You write real code—typed, composable, inspectable.
+
 ## Installation
 
 To install KubernetesJS, you can use npm or yarn:
@@ -34,9 +40,94 @@ yarn add kubernetesjs
 
 ```
 
-## Example
+## Your Infrastructure, Like a Component
+
+This is what we mean by "*React for infrastructure*":
+
+```ts
+import { KubernetesClient } from "kubernetesjs";
+
+const client = new KubernetesClient({
+  restEndpoint: process.env.KUBERNETES_API_URL || 'http://127.0.0.1:8001'
+});
+
+await client.createAppsV1NamespacedDeployment({
+  path: { namespace: 'default' },
+  body: {
+    apiVersion: 'apps/v1',
+    kind: 'Deployment',
+    metadata: { name: 'hello-world' },
+    spec: {
+      replicas: 1,
+      selector: { matchLabels: { app: 'hello-world' } },
+      template: {
+        metadata: { labels: { app: 'hello-world' } },
+        spec: {
+          containers: [
+            {
+              name: 'app',
+              image: 'node:18-alpine',
+              command: ['node', '-e', 'require("http").createServer((_,res)=>res.end("ok")).listen(3000)'],
+              ports: [{ containerPort: 3000 }]
+            }
+          ]
+        }
+      }
+    }
+  }
+});
+```
+
+## Test Your Cluster Like You Test Code
+
+Run infrastructure as part of your test suite, with assertions.
+
+```ts
+describe('PostgreSQL Deployment', () => {
+  const namespace = 'default';
+  const deploymentName = 'postgres-pgvector';
+
+  it('creates a PostgreSQL deployment + service', async () => {
+    const deployment = await client.createAppsV1NamespacedDeployment({ ... });
+    const service = await client.createCoreV1NamespacedService({ ... });
+
+    expect(deployment.metadata?.name).toBe(deploymentName);
+    expect(service.metadata?.name).toBe(deploymentName);
+
+    const status = await client.readAppsV1NamespacedDeployment({
+      path: { namespace, name: deploymentName }
+    });
+
+    expect(status.status?.readyReplicas).toBe(1);
+  });
+});
+```
+
+> Type-safe Kubernetes. With `expect()`.
+
+---
+
+## Declarative Loops, Composability, Reuse
+
+You can now treat infrastructure like reusable components or functions:
+
+```ts
+function createPostgresDeployment(name: string) {
+  return client.createAppsV1NamespacedDeployment({
+    path: { namespace: 'default' },
+    body: {
+      apiVersion: 'apps/v1',
+      kind: 'Deployment',
+      metadata: { name },
+      spec: { /* ... */ }
+    }
+  });
+}
+```
+
+## Example: Inspect Init Containers in Running Pods
 
-```js
+```ts
 import { KubernetesClient } from "kubernetesjs";
 
 const client = new KubernetesClient({
@@ -71,6 +162,14 @@ if (result.items && result.items.length) {
 }
 ```
 
+## Development
+
+Start the Kubernetes API proxy to allow local access:
+
+```bash
+kubectl proxy --port=8001 --accept-hosts='^.*$' --address='0.0.0.0'
+```
+
 ## Related
 
 Checkout these related projects:

package/index.d.ts

@@ -1,4 +1,4 @@
-import { APIClient, APIClientRequestOpts } from "./client";
+import { APIClient, APIClientOptions, APIClientRequestOpts } from "./client";
 export interface MutatingWebhook {
     admissionReviewVersions: string[];
     clientConfig: WebhookClientConfig;
@@ -2732,7 +2732,7 @@ export interface WatchEvent {
 export type RawExtension = {
     [key: string]: unknown;
 };
-export type IntOrString = string;
+export type IntOrString = string | number;
 export interface Info {
     buildDate: string;
     compiler: string;
@@ -10680,7 +10680,7 @@ export interface GetServiceAccountIssuerOpenIDKeysetRequest {
 export interface GetCodeVersionRequest {
 }
 export declare class KubernetesClient extends APIClient {
-    constructor(options: any);
+    constructor(options: APIClientOptions);
     getSwaggerJSON(): Promise<unknown>;
     getServiceAccountIssuerOpenIDConfiguration(params: GetServiceAccountIssuerOpenIDConfigurationRequest, opts?: APIClientRequestOpts): Promise<string>;
     getCoreAPIVersions(params: GetCoreAPIVersionsRequest, opts?: APIClientRequestOpts): Promise<APIVersions>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kubernetesjs",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "description": "Fully Typed Kubernetes",
   "keywords": [
@@ -50,7 +50,7 @@
     "test:deploy": "ts-node scripts/deploy.ts"
   },
   "devDependencies": {
-    "schema-sdk": "^0.11.3"
+    "schema-sdk": "^0.12.0"
   },
-  "gitHead": "58b4ffddde2d9d12304448452449b828ee8aa4c5"
+  "gitHead": "bd0eb9c325a9e3f18687882294b4eaba0c1c5b93"
 }