kubernetes-fluent-client 1.5.0 → 1.6.0

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/dist/kinds.d.ts

@@ -1,4 +1,10 @@
 import { GenericClass, GroupVersionKind } from "./types";
+/**
+ * Converts a model name to a GroupVersionKind
+ *
+ * @param key The name of the model
+ * @returns The GroupVersionKind for the model
+ */
 export declare function modelToGroupVersionKind(key: string): GroupVersionKind;
 /**
  * Registers a new model and GroupVersionKind to be used within the fluent API.

package/dist/kinds.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kinds.d.ts","sourceRoot":"","sources":["../src/kinds.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAwgBzD,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAErE;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,UAAW,YAAY,oBAAoB,gBAAgB,SAUnF,CAAC"}
+{"version":3,"file":"kinds.d.ts","sourceRoot":"","sources":["../src/kinds.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAujBzD;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAErE;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,UAAW,YAAY,oBAAoB,gBAAgB,SAUnF,CAAC"}