kubernetes-fluent-client 1.5.1 → 1.6.0

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const helpers_1 = require("yargs/helpers");
+const yargs_1 = __importDefault(require("yargs/yargs"));
+const generate_1 = require("./generate");
+void (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+    .version(false)
+    .command("crd [source] [directory]", "generate usable types from a K8s CRD", yargs => {
+    return yargs
+        .positional("source", {
+        describe: "the yaml file path, remote url, or K8s CRD name",
+        type: "string",
+    })
+        .positional("directory", {
+        describe: "the directory to output the generated types to",
+        type: "string",
+    })
+        .option("plain", {
+        alias: "p",
+        type: "boolean",
+        description: "generate plain types without binding to the fluent client, automatically enabled when an alternate language is specified",
+    })
+        .option("language", {
+        alias: "l",
+        type: "string",
+        default: "ts",
+        description: "the language to generate types in, see https://github.com/glideapps/quicktype#target-languages for a list of supported languages",
+    })
+        .demandOption(["source", "directory"]);
+}, argv => {
+    void (0, generate_1.generate)(argv);
+})
+    .parse();

package/dist/fetch.js

@@ -1,6 +1,6 @@
 "use strict";
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/dist/fetch.test.js

@@ -1,6 +1,6 @@
 "use strict";
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/dist/fluent/apply.js

@@ -1,4 +1,4 @@
 "use strict";
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/fluent/index.js

@@ -1,6 +1,6 @@
 "use strict";
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.K8s = void 0;
 const http_status_codes_1 = require("http-status-codes");

package/dist/fluent/types.js

@@ -1,6 +1,6 @@
 "use strict";
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WatchPhase = void 0;
 /**

package/dist/fluent/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.k8sExec = exports.k8sCfg = exports.pathBuilder = void 0;
 const client_node_1 = require("@kubernetes/client-node");

package/dist/fluent/utils.test.js

@@ -1,6 +1,6 @@
 "use strict";
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 Object.defineProperty(exports, "__esModule", { value: true });
 const globals_1 = require("@jest/globals");
 const fetch_1 = require("../fetch");

package/dist/fluent/watch.js

@@ -1,6 +1,6 @@
 "use strict";
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/dist/generate.d.ts

@@ -0,0 +1,19 @@
+import { TargetLanguage } from "quicktype-core";
+export interface GenerateOptions {
+    /** The source URL, yaml file path or K8s CRD name */
+    source: string;
+    /** The output directory path */
+    directory?: string;
+    /** Disable kubernetes-fluent-client wrapping */
+    plain?: boolean;
+    /** The language to generate types in */
+    language?: string | TargetLanguage;
+}
+/**
+ * Generate TypeScript types from a K8s CRD
+ *
+ * @param opts The options to use when generating
+ * @returns A promise that resolves when the TypeScript types have been generated
+ */
+export declare function generate(opts: GenerateOptions): Promise<Record<string, string[]>>;
+//# sourceMappingURL=generate.d.ts.map

package/dist/generate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAMA,OAAO,EAIL,cAAc,EAEf,MAAM,gBAAgB,CAAC;AAMxB,MAAM,WAAW,eAAe;IAC9B,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gDAAgD;IAChD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;CACpC;AAyID;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,eAAe,qCAkBnD"}

package/dist/generate.js

@@ -0,0 +1,165 @@
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = void 0;
+const client_node_1 = require("@kubernetes/client-node");
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const quicktype_core_1 = require("quicktype-core");
+const fetch_1 = require("./fetch");
+const fluent_1 = require("./fluent");
+const upstream_1 = require("./upstream");
+/**
+ * Converts a CustomResourceDefinition to TypeScript types
+ *
+ * @param crd The CustomResourceDefinition to convert
+ * @param opts The options to use when converting
+ * @returns A promise that resolves when the CustomResourceDefinition has been converted
+ */
+async function convertCRDtoTS(crd, opts) {
+    // Get the name of the kind
+    const name = crd.spec.names.kind;
+    const results = {};
+    for (const match of crd.spec.versions) {
+        // Get the schema from the matched version
+        const schema = JSON.stringify(match?.schema?.openAPIV3Schema);
+        // Create a new JSONSchemaInput
+        const schemaInput = new quicktype_core_1.JSONSchemaInput(new quicktype_core_1.FetchingJSONSchemaStore());
+        // Add the schema to the input
+        await schemaInput.addSource({ name, schema });
+        // Create a new InputData object
+        const inputData = new quicktype_core_1.InputData();
+        inputData.addInput(schemaInput);
+        // Generate the types
+        const out = await (0, quicktype_core_1.quicktype)({
+            inputData,
+            lang: opts.language || "ts",
+            rendererOptions: { "just-types": "true" },
+        });
+        let processedLines = out.lines;
+        // If using typescript, remove the line containing `[property: string]: any;`
+        if (opts.language === "ts" || opts.language === "typescript") {
+            processedLines = out.lines.filter(line => !line.includes("[property: string]: any;"));
+        }
+        // If the language is TypeScript and plain is not specified, wire up the fluent client
+        if (opts.language === "ts" && !opts.plain) {
+            processedLines.unshift(
+            // Add warning that the file is auto-generated
+            `// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n`, 
+            // Add the imports before any other lines
+            `import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n`);
+            // Replace the interface with a named class that extends GenericKind
+            const entryIdx = processedLines.findIndex(line => line.includes(`export interface ${name} {`));
+            // Replace the interface with a named class that extends GenericKind
+            processedLines[entryIdx] = `export class ${name} extends GenericKind {`;
+            // Add the RegisterKind call
+            processedLines.push(`RegisterKind(${name}, {`);
+            processedLines.push(`  group: "${crd.spec.group}",`);
+            processedLines.push(`  version: "${match.name}",`);
+            processedLines.push(`  kind: "${name}",`);
+            processedLines.push(`});`);
+        }
+        const finalContents = processedLines.join("\n");
+        const fileName = `${name.toLowerCase()}-${match.name.toLowerCase()}`;
+        // If an output file is specified, write the output to the file
+        if (opts.directory) {
+            // Create the directory if it doesn't exist
+            fs.mkdirSync(opts.directory, { recursive: true });
+            // Write the file
+            const filePath = path.join(opts.directory, `${fileName}.${opts.language}`);
+            fs.writeFileSync(filePath, finalContents);
+        }
+        // Add the results to the array
+        results[fileName] = processedLines;
+    }
+    return results;
+}
+/**
+ * Reads a CustomResourceDefinition from a file, the cluster or the internet
+ *
+ * @param source The source to read from (file path, cluster or URL)
+ * @returns A promise that resolves when the CustomResourceDefinition has been read
+ */
+async function readOrFetchCrd(source) {
+    const filePath = path.join(process.cwd(), source);
+    // First try to read the source as a file
+    try {
+        if (fs.existsSync(filePath)) {
+            const payload = fs.readFileSync(filePath, "utf8");
+            return (0, client_node_1.loadAllYaml)(payload);
+        }
+    }
+    catch (e) {
+        // Ignore errors
+    }
+    // Next try to parse the source as a URL
+    try {
+        const url = new URL(source);
+        // If the source is a URL, fetch it
+        if (url.protocol === "http:" || url.protocol === "https:") {
+            const { ok, data } = await (0, fetch_1.fetch)(source);
+            // If the request failed, throw an error
+            if (!ok) {
+                throw new Error(`Failed to fetch ${source}: ${data}`);
+            }
+            return (0, client_node_1.loadAllYaml)(data);
+        }
+    }
+    catch (e) {
+        // Ignore errors
+    }
+    // Finally, if the source is not a file or URL, try to read it as a CustomResourceDefinition from the cluster
+    try {
+        return [await (0, fluent_1.K8s)(upstream_1.CustomResourceDefinition).Get(source)];
+    }
+    catch (e) {
+        throw new Error(`Failed to read ${source} as a file, url or K8s CRD: ${e}`);
+    }
+}
+/**
+ * Generate TypeScript types from a K8s CRD
+ *
+ * @param opts The options to use when generating
+ * @returns A promise that resolves when the TypeScript types have been generated
+ */
+async function generate(opts) {
+    const crds = await readOrFetchCrd(opts.source);
+    const results = {};
+    for (const crd of crds) {
+        if (!crd || crd.kind !== "CustomResourceDefinition" || !crd.spec?.versions?.length) {
+            // Ignore empty and non-CRD objects
+            continue;
+        }
+        // Add the results to the record
+        const out = await convertCRDtoTS(crd, opts);
+        for (const key of Object.keys(out)) {
+            results[key] = out[key];
+        }
+    }
+    return results;
+}
+exports.generate = generate;

package/dist/generate.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generate.test.d.ts.map

package/dist/generate.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.test.d.ts","sourceRoot":"","sources":["../src/generate.test.ts"],"names":[],"mappings":""}

package/dist/generate.test.js

@@ -0,0 +1,256 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const generate_1 = require("./generate");
+const fs_1 = __importDefault(require("fs"));
+const sampleYaml = `
+# non-crd should be ignored
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+  namespace: default
+data:
+  any: bleh
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: movies.example.com
+spec:
+  group: example.com
+  names:
+    kind: Movie
+    plural: movies
+  scope: Namespaced
+  versions:
+    - name: v1
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Movie nerd
+          properties:
+            spec:
+              properties:
+                title:
+                  type: string
+                author:
+                  type: string
+              type: object
+---
+# duplicate entries should not break things
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: movies.example.com
+spec:
+  group: example.com
+  names:
+    kind: Movie
+    plural: movies
+  scope: Namespaced
+  versions:
+    - name: v1
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Movie nerd
+          properties:
+            spec:
+              properties:
+                title:
+                  type: string
+                author:
+                  type: string
+              type: object
+---            
+# should support multiple versions
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: books.example.com
+spec:
+  group: example.com
+  names:
+    kind: Book
+    plural: books
+  scope: Namespaced
+  versions:
+    - name: v1
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Book nerd
+          properties:
+            spec:
+              properties:
+                title:
+                  type: string
+                author:
+                  type: string
+              type: object
+    - name: v2
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Book nerd
+          properties:
+            spec:
+              properties:
+                author:
+                  type: string
+              type: object
+      served: true
+      storage: true
+`;
+globals_1.jest.mock("./fetch", () => ({
+    fetch: globals_1.jest.fn(),
+}));
+globals_1.jest.mock("./fluent", () => ({
+    K8s: globals_1.jest.fn(),
+}));
+(0, globals_1.describe)("CRD to TypeScript Conversion", () => {
+    const originalReadFileSync = fs_1.default.readFileSync;
+    globals_1.jest.isolateModules(() => {
+        globals_1.jest.spyOn(fs_1.default, "existsSync").mockReturnValue(true);
+        globals_1.jest.spyOn(fs_1.default, "readFileSync").mockImplementation((...args) => {
+            // Super janky hack due ot source-map-support calling readFileSync internally
+            if (args[0].toString().includes("test-crd.yaml")) {
+                return sampleYaml;
+            }
+            return originalReadFileSync(...args);
+        });
+        globals_1.jest.spyOn(fs_1.default, "mkdirSync").mockReturnValue(undefined);
+        globals_1.jest.spyOn(fs_1.default, "writeFileSync").mockReturnValue(undefined);
+    });
+    (0, globals_1.beforeEach)(() => {
+        globals_1.jest.clearAllMocks();
+    });
+    (0, globals_1.test)("converts CRD to TypeScript", async () => {
+        const options = { source: "test-crd.yaml", language: "ts" }; // specify your options
+        const actual = await (0, generate_1.generate)(options);
+        const expectedMovie = [
+            "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+            "/**",
+            " * Movie nerd",
+            " */",
+            "export class Movie extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Movie, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Movie",',
+            "});",
+        ];
+        const expectedBookV1 = [
+            "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+            'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+            "/**",
+            " * Book nerd",
+            " */",
+            "export class Book extends GenericKind {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+            "RegisterKind(Book, {",
+            '  group: "example.com",',
+            '  version: "v1",',
+            '  kind: "Book",',
+            "});",
+        ];
+        const expectedBookV2 = expectedBookV1
+            .filter(line => !line.includes("title?"))
+            .map(line => line.replace("v1", "v2"));
+        (0, globals_1.expect)(actual["movie-v1"]).toEqual(expectedMovie);
+        (0, globals_1.expect)(actual["book-v1"]).toEqual(expectedBookV1);
+        (0, globals_1.expect)(actual["book-v2"]).toEqual(expectedBookV2);
+    });
+    (0, globals_1.test)("converts CRD to TypeScript with plain option", async () => {
+        const options = { source: "test-crd.yaml", language: "ts", plain: true }; // specify your options
+        const actual = await (0, generate_1.generate)(options);
+        const expectedMovie = [
+            "/**",
+            " * Movie nerd",
+            " */",
+            "export interface Movie {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+        ];
+        const expectedBookV1 = [
+            "/**",
+            " * Book nerd",
+            " */",
+            "export interface Book {",
+            "    spec?: Spec;",
+            "}",
+            "",
+            "export interface Spec {",
+            "    author?: string;",
+            "    title?:  string;",
+            "}",
+            "",
+        ];
+        const expectedBookV2 = expectedBookV1
+            .filter(line => !line.includes("title?"))
+            .map(line => line.replace("v1", "v2"));
+        (0, globals_1.expect)(actual["movie-v1"]).toEqual(expectedMovie);
+        (0, globals_1.expect)(actual["book-v1"]).toEqual(expectedBookV1);
+        (0, globals_1.expect)(actual["book-v2"]).toEqual(expectedBookV2);
+    });
+    (0, globals_1.test)("converts CRD to Go", async () => {
+        const options = { source: "test-crd.yaml", language: "go" }; // specify your options
+        const actual = await (0, generate_1.generate)(options);
+        const expectedMovie = [
+            "// Movie nerd",
+            "type Movie struct {",
+            '\tSpec *Spec `json:"spec,omitempty"`',
+            "}",
+            "",
+            "type Spec struct {",
+            '\tAuthor *string `json:"author,omitempty"`',
+            '\tTitle  *string `json:"title,omitempty"`',
+            "}",
+            "",
+        ];
+        const expectedBookV1 = [
+            "// Book nerd",
+            "type Book struct {",
+            '\tSpec *Spec `json:"spec,omitempty"`',
+            "}",
+            "",
+            "type Spec struct {",
+            '\tAuthor *string `json:"author,omitempty"`',
+            '\tTitle  *string `json:"title,omitempty"`',
+            "}",
+            "",
+        ];
+        const expectedBookV2 = expectedBookV1
+            .filter(line => !line.includes("Title"))
+            .map(line => line.replace("v1", "v2"));
+        (0, globals_1.expect)(actual["movie-v1"]).toEqual(expectedMovie);
+        (0, globals_1.expect)(actual["book-v1"]).toEqual(expectedBookV1);
+        (0, globals_1.expect)(actual["book-v2"]).toEqual(expectedBookV2);
+    });
+});

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export { fetch } from "./fetch";
 export { StatusCodes as fetchStatus } from "http-status-codes";
 export { K8s } from "./fluent";
 export { RegisterKind, modelToGroupVersionKind } from "./kinds";
+export { GenericKind } from "./types";
 export * from "./types";
 export * as K8sClientNode from "@kubernetes/client-node";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,oGAAoG;AACpG,OAAO,EAAE,IAAI,EAAE,CAAC;AAGhB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC,OAAO,EAAE,WAAW,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAG/D,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAEhE,cAAc,SAAS,CAAC;AAExB,OAAO,KAAK,aAAa,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,oGAAoG;AACpG,OAAO,EAAE,IAAI,EAAE,CAAC;AAGhB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC,OAAO,EAAE,WAAW,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAG/D,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAGhE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,cAAc,SAAS,CAAC;AAExB,OAAO,KAAK,aAAa,MAAM,yBAAyB,CAAC"}

package/dist/index.js

@@ -28,7 +28,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.K8sClientNode = exports.modelToGroupVersionKind = exports.RegisterKind = exports.K8s = exports.fetchStatus = exports.fetch = exports.kind = void 0;
+exports.K8sClientNode = exports.GenericKind = exports.modelToGroupVersionKind = exports.RegisterKind = exports.K8s = exports.fetchStatus = exports.fetch = exports.kind = void 0;
 // Export kinds as a single object
 const kind = __importStar(require("./upstream"));
 exports.kind = kind;
@@ -45,5 +45,8 @@ Object.defineProperty(exports, "K8s", { enumerable: true, get: function () { ret
 var kinds_1 = require("./kinds");
 Object.defineProperty(exports, "RegisterKind", { enumerable: true, get: function () { return kinds_1.RegisterKind; } });
 Object.defineProperty(exports, "modelToGroupVersionKind", { enumerable: true, get: function () { return kinds_1.modelToGroupVersionKind; } });
+// Export the GenericKind interface for CRD registration
+var types_1 = require("./types");
+Object.defineProperty(exports, "GenericKind", { enumerable: true, get: function () { return types_1.GenericKind; } });
 __exportStar(require("./types"), exports);
 exports.K8sClientNode = __importStar(require("@kubernetes/client-node"));

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "kubernetes-fluent-client",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply",
+  "bin": "./dist/cli.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -39,18 +40,22 @@
     "fast-json-patch": "3.1.1",
     "http-status-codes": "2.3.0",
     "node-fetch": "2.7.0",
-    "type-fest": "4.3.3"
+    "quicktype-core": "23.0.76",
+    "type-fest": "4.4.0",
+    "yargs": "17.7.2"
   },
   "devDependencies": {
     "@commitlint/cli": "17.7.2",
     "@commitlint/config-conventional": "17.7.0",
     "@jest/globals": "29.7.0",
     "@types/byline": "4.2.34",
-    "@typescript-eslint/eslint-plugin": "6.7.4",
-    "@typescript-eslint/parser": "6.7.4",
+    "@types/readable-stream": "4.0.3",
+    "@types/yargs": "17.0.28",
+    "@typescript-eslint/eslint-plugin": "6.7.5",
+    "@typescript-eslint/parser": "6.7.5",
     "eslint-plugin-jsdoc": "46.8.2",
     "jest": "29.7.0",
-    "nock": "13.3.3",
+    "nock": "13.3.4",
     "prettier": "3.0.3",
     "semantic-release": "22.0.5",
     "ts-jest": "29.1.1",

package/src/cli.ts

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+
+import { hideBin } from "yargs/helpers";
+import yargs from "yargs/yargs";
+import { GenerateOptions, generate } from "./generate";
+
+void yargs(hideBin(process.argv))
+  .version(false)
+  .command(
+    "crd [source] [directory]",
+    "generate usable types from a K8s CRD",
+    yargs => {
+      return yargs
+        .positional("source", {
+          describe: "the yaml file path, remote url, or K8s CRD name",
+          type: "string",
+        })
+        .positional("directory", {
+          describe: "the directory to output the generated types to",
+          type: "string",
+        })
+        .option("plain", {
+          alias: "p",
+          type: "boolean",
+          description:
+            "generate plain types without binding to the fluent client, automatically enabled when an alternate language is specified",
+        })
+        .option("language", {
+          alias: "l",
+          type: "string",
+          default: "ts",
+          description:
+            "the language to generate types in, see https://github.com/glideapps/quicktype#target-languages for a list of supported languages",
+        })
+        .demandOption(["source", "directory"]);
+    },
+    argv => {
+      void generate(argv as GenerateOptions);
+    },
+  )
+  .parse();

package/src/fetch.test.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { expect, test, beforeEach } from "@jest/globals";
 

package/src/fetch.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { StatusCodes } from "http-status-codes";
 import fetchRaw, { FetchError, RequestInfo, RequestInit } from "node-fetch";

package/src/fluent/apply.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 /**
  * Configuration for the apply function.

package/src/fluent/index.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
 import { Operation } from "fast-json-patch";

package/src/fluent/types.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
 import { Operation } from "fast-json-patch";

package/src/fluent/utils.test.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { beforeEach, describe, expect, it, jest } from "@jest/globals";
 

package/src/fluent/utils.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { KubeConfig, PatchStrategy } from "@kubernetes/client-node";
 

package/src/fluent/watch.ts

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import byline from "byline";
 import fetch from "node-fetch";

package/src/generate.test.ts

@@ -0,0 +1,266 @@
+import { beforeEach, describe, expect, jest, test } from "@jest/globals";
+import { generate } from "./generate";
+import fs from "fs";
+
+const sampleYaml = `
+# non-crd should be ignored
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+  namespace: default
+data:
+  any: bleh
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: movies.example.com
+spec:
+  group: example.com
+  names:
+    kind: Movie
+    plural: movies
+  scope: Namespaced
+  versions:
+    - name: v1
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Movie nerd
+          properties:
+            spec:
+              properties:
+                title:
+                  type: string
+                author:
+                  type: string
+              type: object
+---
+# duplicate entries should not break things
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: movies.example.com
+spec:
+  group: example.com
+  names:
+    kind: Movie
+    plural: movies
+  scope: Namespaced
+  versions:
+    - name: v1
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Movie nerd
+          properties:
+            spec:
+              properties:
+                title:
+                  type: string
+                author:
+                  type: string
+              type: object
+---            
+# should support multiple versions
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: books.example.com
+spec:
+  group: example.com
+  names:
+    kind: Book
+    plural: books
+  scope: Namespaced
+  versions:
+    - name: v1
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Book nerd
+          properties:
+            spec:
+              properties:
+                title:
+                  type: string
+                author:
+                  type: string
+              type: object
+    - name: v2
+      schema:
+        openAPIV3Schema:
+          type: object
+          description: Book nerd
+          properties:
+            spec:
+              properties:
+                author:
+                  type: string
+              type: object
+      served: true
+      storage: true
+`;
+
+jest.mock("./fetch", () => ({
+  fetch: jest.fn(),
+}));
+
+jest.mock("./fluent", () => ({
+  K8s: jest.fn(),
+}));
+
+describe("CRD to TypeScript Conversion", () => {
+  const originalReadFileSync = fs.readFileSync;
+
+  jest.isolateModules(() => {
+    jest.spyOn(fs, "existsSync").mockReturnValue(true);
+    jest.spyOn(fs, "readFileSync").mockImplementation((...args) => {
+      // Super janky hack due ot source-map-support calling readFileSync internally
+      if (args[0].toString().includes("test-crd.yaml")) {
+        return sampleYaml;
+      }
+      return originalReadFileSync(...args);
+    });
+    jest.spyOn(fs, "mkdirSync").mockReturnValue(undefined);
+    jest.spyOn(fs, "writeFileSync").mockReturnValue(undefined);
+  });
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  test("converts CRD to TypeScript", async () => {
+    const options = { source: "test-crd.yaml", language: "ts" }; // specify your options
+
+    const actual = await generate(options);
+    const expectedMovie = [
+      "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+      'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+      "/**",
+      " * Movie nerd",
+      " */",
+      "export class Movie extends GenericKind {",
+      "    spec?: Spec;",
+      "}",
+      "",
+      "export interface Spec {",
+      "    author?: string;",
+      "    title?:  string;",
+      "}",
+      "",
+      "RegisterKind(Movie, {",
+      '  group: "example.com",',
+      '  version: "v1",',
+      '  kind: "Movie",',
+      "});",
+    ];
+    const expectedBookV1 = [
+      "// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n",
+      'import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n',
+      "/**",
+      " * Book nerd",
+      " */",
+      "export class Book extends GenericKind {",
+      "    spec?: Spec;",
+      "}",
+      "",
+      "export interface Spec {",
+      "    author?: string;",
+      "    title?:  string;",
+      "}",
+      "",
+      "RegisterKind(Book, {",
+      '  group: "example.com",',
+      '  version: "v1",',
+      '  kind: "Book",',
+      "});",
+    ];
+    const expectedBookV2 = expectedBookV1
+      .filter(line => !line.includes("title?"))
+      .map(line => line.replace("v1", "v2"));
+
+    expect(actual["movie-v1"]).toEqual(expectedMovie);
+    expect(actual["book-v1"]).toEqual(expectedBookV1);
+    expect(actual["book-v2"]).toEqual(expectedBookV2);
+  });
+
+  test("converts CRD to TypeScript with plain option", async () => {
+    const options = { source: "test-crd.yaml", language: "ts", plain: true }; // specify your options
+
+    const actual = await generate(options);
+    const expectedMovie = [
+      "/**",
+      " * Movie nerd",
+      " */",
+      "export interface Movie {",
+      "    spec?: Spec;",
+      "}",
+      "",
+      "export interface Spec {",
+      "    author?: string;",
+      "    title?:  string;",
+      "}",
+      "",
+    ];
+    const expectedBookV1 = [
+      "/**",
+      " * Book nerd",
+      " */",
+      "export interface Book {",
+      "    spec?: Spec;",
+      "}",
+      "",
+      "export interface Spec {",
+      "    author?: string;",
+      "    title?:  string;",
+      "}",
+      "",
+    ];
+    const expectedBookV2 = expectedBookV1
+      .filter(line => !line.includes("title?"))
+      .map(line => line.replace("v1", "v2"));
+
+    expect(actual["movie-v1"]).toEqual(expectedMovie);
+    expect(actual["book-v1"]).toEqual(expectedBookV1);
+    expect(actual["book-v2"]).toEqual(expectedBookV2);
+  });
+
+  test("converts CRD to Go", async () => {
+    const options = { source: "test-crd.yaml", language: "go" }; // specify your options
+
+    const actual = await generate(options);
+    const expectedMovie = [
+      "// Movie nerd",
+      "type Movie struct {",
+      '\tSpec *Spec `json:"spec,omitempty"`',
+      "}",
+      "",
+      "type Spec struct {",
+      '\tAuthor *string `json:"author,omitempty"`',
+      '\tTitle  *string `json:"title,omitempty"`',
+      "}",
+      "",
+    ];
+    const expectedBookV1 = [
+      "// Book nerd",
+      "type Book struct {",
+      '\tSpec *Spec `json:"spec,omitempty"`',
+      "}",
+      "",
+      "type Spec struct {",
+      '\tAuthor *string `json:"author,omitempty"`',
+      '\tTitle  *string `json:"title,omitempty"`',
+      "}",
+      "",
+    ];
+    const expectedBookV2 = expectedBookV1
+      .filter(line => !line.includes("Title"))
+      .map(line => line.replace("v1", "v2"));
+
+    expect(actual["movie-v1"]).toEqual(expectedMovie);
+    expect(actual["book-v1"]).toEqual(expectedBookV1);
+    expect(actual["book-v2"]).toEqual(expectedBookV2);
+  });
+});

package/src/generate.ts

@@ -0,0 +1,189 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+
+import { loadAllYaml } from "@kubernetes/client-node";
+import * as fs from "fs";
+import * as path from "path";
+import {
+  FetchingJSONSchemaStore,
+  InputData,
+  JSONSchemaInput,
+  TargetLanguage,
+  quicktype,
+} from "quicktype-core";
+
+import { fetch } from "./fetch";
+import { K8s } from "./fluent";
+import { CustomResourceDefinition } from "./upstream";
+
+export interface GenerateOptions {
+  /** The source URL, yaml file path or K8s CRD name */
+  source: string;
+  /** The output directory path */
+  directory?: string;
+  /** Disable kubernetes-fluent-client wrapping */
+  plain?: boolean;
+  /** The language to generate types in */
+  language?: string | TargetLanguage;
+}
+
+/**
+ * Converts a CustomResourceDefinition to TypeScript types
+ *
+ * @param crd The CustomResourceDefinition to convert
+ * @param opts The options to use when converting
+ * @returns A promise that resolves when the CustomResourceDefinition has been converted
+ */
+async function convertCRDtoTS(
+  crd: CustomResourceDefinition,
+  opts: GenerateOptions,
+): Promise<Record<string, string[]>> {
+  // Get the name of the kind
+  const name = crd.spec.names.kind;
+
+  const results: Record<string, string[]> = {};
+
+  for (const match of crd.spec.versions) {
+    // Get the schema from the matched version
+    const schema = JSON.stringify(match?.schema?.openAPIV3Schema);
+
+    // Create a new JSONSchemaInput
+    const schemaInput = new JSONSchemaInput(new FetchingJSONSchemaStore());
+
+    // Add the schema to the input
+    await schemaInput.addSource({ name, schema });
+
+    // Create a new InputData object
+    const inputData = new InputData();
+    inputData.addInput(schemaInput);
+
+    // Generate the types
+    const out = await quicktype({
+      inputData,
+      lang: opts.language || "ts",
+      rendererOptions: { "just-types": "true" },
+    });
+
+    let processedLines = out.lines;
+
+    // If using typescript, remove the line containing `[property: string]: any;`
+    if (opts.language === "ts" || opts.language === "typescript") {
+      processedLines = out.lines.filter(line => !line.includes("[property: string]: any;"));
+    }
+
+    // If the language is TypeScript and plain is not specified, wire up the fluent client
+    if (opts.language === "ts" && !opts.plain) {
+      processedLines.unshift(
+        // Add warning that the file is auto-generated
+        `// This file is auto-generated by kubernetes-fluent-client, do not edit manually\n`,
+        // Add the imports before any other lines
+        `import { GenericKind, RegisterKind } from "kubernetes-fluent-client";\n`,
+      );
+
+      // Replace the interface with a named class that extends GenericKind
+      const entryIdx = processedLines.findIndex(line =>
+        line.includes(`export interface ${name} {`),
+      );
+
+      // Replace the interface with a named class that extends GenericKind
+      processedLines[entryIdx] = `export class ${name} extends GenericKind {`;
+
+      // Add the RegisterKind call
+      processedLines.push(`RegisterKind(${name}, {`);
+      processedLines.push(`  group: "${crd.spec.group}",`);
+      processedLines.push(`  version: "${match.name}",`);
+      processedLines.push(`  kind: "${name}",`);
+      processedLines.push(`});`);
+    }
+
+    const finalContents = processedLines.join("\n");
+    const fileName = `${name.toLowerCase()}-${match.name.toLowerCase()}`;
+
+    // If an output file is specified, write the output to the file
+    if (opts.directory) {
+      // Create the directory if it doesn't exist
+      fs.mkdirSync(opts.directory, { recursive: true });
+
+      // Write the file
+      const filePath = path.join(opts.directory, `${fileName}.${opts.language}`);
+      fs.writeFileSync(filePath, finalContents);
+    }
+
+    // Add the results to the array
+    results[fileName] = processedLines;
+  }
+
+  return results;
+}
+
+/**
+ * Reads a CustomResourceDefinition from a file, the cluster or the internet
+ *
+ * @param source The source to read from (file path, cluster or URL)
+ * @returns A promise that resolves when the CustomResourceDefinition has been read
+ */
+async function readOrFetchCrd(source: string): Promise<CustomResourceDefinition[]> {
+  const filePath = path.join(process.cwd(), source);
+
+  // First try to read the source as a file
+  try {
+    if (fs.existsSync(filePath)) {
+      const payload = fs.readFileSync(filePath, "utf8");
+      return loadAllYaml(payload) as CustomResourceDefinition[];
+    }
+  } catch (e) {
+    // Ignore errors
+  }
+
+  // Next try to parse the source as a URL
+  try {
+    const url = new URL(source);
+
+    // If the source is a URL, fetch it
+    if (url.protocol === "http:" || url.protocol === "https:") {
+      const { ok, data } = await fetch<string>(source);
+
+      // If the request failed, throw an error
+      if (!ok) {
+        throw new Error(`Failed to fetch ${source}: ${data}`);
+      }
+
+      return loadAllYaml(data) as CustomResourceDefinition[];
+    }
+  } catch (e) {
+    // Ignore errors
+  }
+
+  // Finally, if the source is not a file or URL, try to read it as a CustomResourceDefinition from the cluster
+  try {
+    return [await K8s(CustomResourceDefinition).Get(source)];
+  } catch (e) {
+    throw new Error(`Failed to read ${source} as a file, url or K8s CRD: ${e}`);
+  }
+}
+
+/**
+ * Generate TypeScript types from a K8s CRD
+ *
+ * @param opts The options to use when generating
+ * @returns A promise that resolves when the TypeScript types have been generated
+ */
+export async function generate(opts: GenerateOptions) {
+  const crds = await readOrFetchCrd(opts.source);
+  const results: Record<string, string[]> = {};
+
+  for (const crd of crds) {
+    if (!crd || crd.kind !== "CustomResourceDefinition" || !crd.spec?.versions?.length) {
+      // Ignore empty and non-CRD objects
+      continue;
+    }
+
+    // Add the results to the record
+    const out = await convertCRDtoTS(crd, opts);
+    for (const key of Object.keys(out)) {
+      results[key] = out[key];
+    }
+  }
+
+  return results;
+}

package/src/index.ts

@@ -19,6 +19,9 @@ export { K8s } from "./fluent";
 // Export helpers for working with K8s types
 export { RegisterKind, modelToGroupVersionKind } from "./kinds";
 
+// Export the GenericKind interface for CRD registration
+export { GenericKind } from "./types";
+
 export * from "./types";
 
 export * as K8sClientNode from "@kubernetes/client-node";