kubernetes-fluent-client 1.5.1 → 1.6.1

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,46 @@
+#!/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"]);
+}, async (argv) => {
+    const opts = argv;
+    opts.logFn = console.log;
+    try {
+        await (0, generate_1.generate)(opts);
+    }
+    catch (e) {
+        console.log(`\n❌ ${e.message}`);
+    }
+})
+    .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,24 @@
+import { TargetLanguage } from "quicktype-core";
+import { LogFn } from "./types";
+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;
+    /** Override the NPM package to import when generating formatted Typescript */
+    npmPackage?: string;
+    /** Log function callback */
+    logFn: LogFn;
+}
+/**
+ * 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;AAKxB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,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;IACnC,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,KAAK,EAAE,KAAK,CAAC;CACd;AAiKD;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,IAAI,EAAE,eAAe,qCA4BnD"}

package/dist/generate.js

@@ -0,0 +1,187 @@
+"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) {
+        const version = match.name;
+        // 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());
+        opts.logFn(`- Generating ${crd.spec.group}/${version} types for ${name}`);
+        // 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);
+        // If the language is not specified, default to TypeScript
+        if (!opts.language) {
+            opts.language = "ts";
+        }
+        // Generate the types
+        const out = await (0, quicktype_core_1.quicktype)({
+            inputData,
+            lang: opts.language,
+            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) {
+            if (!opts.npmPackage) {
+                opts.npmPackage = "kubernetes-fluent-client";
+            }
+            processedLines.unshift(
+            // Add warning that the file is auto-generated
+            `// This file is auto-generated by ${opts.npmPackage}, do not edit manually\n`, 
+            // Add the imports before any other lines
+            `import { GenericKind, RegisterKind } from "${opts.npmPackage}";\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: "${version}",`);
+            processedLines.push(`  kind: "${name}",`);
+            processedLines.push(`});`);
+        }
+        const finalContents = processedLines.join("\n");
+        const fileName = `${name.toLowerCase()}-${version.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 opts The options to use when reading
+ * @returns A promise that resolves when the CustomResourceDefinition has been read
+ */
+async function readOrFetchCrd(opts) {
+    const { source, logFn } = opts;
+    const filePath = path.join(process.cwd(), source);
+    // First try to read the source as a file
+    try {
+        if (fs.existsSync(filePath)) {
+            logFn(`Attempting to load ${source} as a local file`);
+            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:") {
+            logFn(`Attempting to load ${source} as a URL`);
+            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) {
+        // If invalid, ignore the error
+        if (e.code !== "ERR_INVALID_URL") {
+            throw new Error(e);
+        }
+    }
+    // Finally, if the source is not a file or URL, try to read it as a CustomResourceDefinition from the cluster
+    try {
+        logFn(`Attempting to read ${source} from the current Kubernetes context`);
+        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.data?.message || "Cluster not available"}`);
+    }
+}
+/**
+ * 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)).filter(crd => !!crd);
+    const results = {};
+    opts.logFn("");
+    for (const crd of crds) {
+        if (crd.kind !== "CustomResourceDefinition" || !crd.spec?.versions?.length) {
+            opts.logFn(`Skipping ${crd?.metadata?.name}, it does not appear to be a CRD`);
+            // 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];
+        }
+    }
+    if (opts.directory) {
+        // Notify the user that the files have been generated
+        opts.logFn(`\n✅ Generated ${Object.keys(results).length} files in the ${opts.directory} directory`);
+    }
+    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":""}