kubernetes-fluent-client 3.0.3 → 4.0.0-rc-http2-watch

package/dist/generate.js

@@ -25,6 +25,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertCRDtoTS = convertCRDtoTS;
+exports.prepareInputData = prepareInputData;
+exports.generateTypes = generateTypes;
+exports.writeGeneratedFile = writeGeneratedFile;
+exports.readOrFetchCrd = readOrFetchCrd;
+exports.resolveFilePath = resolveFilePath;
+exports.tryParseUrl = tryParseUrl;
 exports.generate = generate;
 const client_node_1 = require("@kubernetes/client-node");
 const fs = __importStar(require("fs"));
@@ -36,144 +43,150 @@ 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
+ * @param crd - The CustomResourceDefinition object to convert.
+ * @param opts - The options for generating the TypeScript types.
+ * @returns A promise that resolves to a record of generated TypeScript types.
  */
 async function convertCRDtoTS(crd, opts) {
-    // Get the name of the kind
     const name = crd.spec.names.kind;
     const results = {};
+    const output = [];
+    // Check for missing versions or empty schema
+    if (!crd.spec.versions || crd.spec.versions.length === 0) {
+        opts.logFn(`Skipping ${crd.metadata?.name}, it does not appear to be a CRD`);
+        return [];
+    }
+    // Iterate through each version of the CRD
     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(`  plural: "${crd.spec.names.plural}",`);
-            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);
+        if (!match.schema?.openAPIV3Schema) {
+            opts.logFn(`Skipping ${crd.metadata?.name ?? "unknown"}, it does not appear to have a valid schema`);
+            continue;
         }
-        // Add the results to the array
-        results[fileName] = processedLines;
+        const schema = JSON.stringify(match.schema.openAPIV3Schema);
+        opts.logFn(`- Generating ${crd.spec.group}/${match.name} types for ${name}`);
+        const inputData = await prepareInputData(name, schema);
+        const generatedTypes = await generateTypes(inputData, opts);
+        const fileName = `${name.toLowerCase()}-${match.name.toLowerCase()}`;
+        writeGeneratedFile(fileName, opts.directory || "", generatedTypes, opts.language || "ts");
+        results[fileName] = generatedTypes;
+        output.push({ results, name, crd, version: match.name });
     }
-    return results;
+    return output;
+}
+/**
+ * Prepares the input data for quicktype from the provided schema.
+ *
+ * @param name - The name of the schema.
+ * @param schema - The JSON schema as a string.
+ * @returns A promise that resolves to the input data for quicktype.
+ */
+async function prepareInputData(name, schema) {
+    // 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);
+    return inputData;
 }
 /**
- * Reads a CustomResourceDefinition from a file, the cluster or the internet
+ * Generates TypeScript types using quicktype.
  *
- * @param opts The options to use when reading
- * @returns A promise that resolves when the CustomResourceDefinition has been read
+ * @param inputData - The input data for quicktype.
+ * @param opts - The options for generating the TypeScript types.
+ * @returns A promise that resolves to an array of generated TypeScript type lines.
+ */
+async function generateTypes(inputData, opts) {
+    // If the language is not specified, default to TypeScript
+    const language = opts.language || "ts";
+    // Generate the types
+    const out = await (0, quicktype_core_1.quicktype)({
+        inputData,
+        lang: language,
+        rendererOptions: { "just-types": "true" },
+    });
+    return out.lines;
+}
+/**
+ * Writes the processed lines to the output file.
+ *
+ * @param fileName - The name of the file to write.
+ * @param directory - The directory where the file will be written.
+ * @param content - The content to write to the file.
+ * @param language - The programming language of the file.
+ */
+function writeGeneratedFile(fileName, directory, content, language) {
+    language = language || "ts";
+    if (!directory)
+        return;
+    const filePath = path.join(directory, `${fileName}.${language}`);
+    fs.mkdirSync(directory, { recursive: true });
+    fs.writeFileSync(filePath, content.join("\n"));
+}
+/**
+ * Reads or fetches a CustomResourceDefinition from a file, URL, or the cluster.
+ *
+ * @param opts - The options for generating the TypeScript types.
+ * @returns A promise that resolves to an array of CustomResourceDefinition objects.
  */
 async function readOrFetchCrd(opts) {
-    const { source, logFn } = opts;
-    let filePath;
-    if (source[0] === "/") {
-        // If source is an absolute path
-        filePath = source;
-    }
-    else {
-        // If source is a relative path
-        filePath = path.join(process.cwd(), source);
-    }
-    // First try to read the source as a file
     try {
+        const filePath = resolveFilePath(opts.source);
         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);
+            opts.logFn(`Attempting to load ${opts.source} as a local file`);
+            const content = fs.readFileSync(filePath, "utf8");
+            return (0, client_node_1.loadAllYaml)(content);
         }
-    }
-    catch {
-        // 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}`);
+        const url = tryParseUrl(opts.source);
+        if (url) {
+            opts.logFn(`Attempting to load ${opts.source} as a URL`);
+            const { ok, data } = await (0, fetch_1.fetch)(url.href);
+            if (ok) {
+                return (0, client_node_1.loadAllYaml)(data);
             }
-            return (0, client_node_1.loadAllYaml)(data);
         }
+        // Fallback to Kubernetes cluster
+        opts.logFn(`Attempting to read ${opts.source} from the Kubernetes cluster`);
+        return [await (0, fluent_1.K8s)(upstream_1.CustomResourceDefinition).Get(opts.source)];
     }
-    catch (e) {
-        // If invalid, ignore the error
-        if (e.code !== "ERR_INVALID_URL") {
-            throw new Error(`Error parsing URL ${source}`);
-        }
+    catch (error) {
+        opts.logFn(`Error loading CRD: ${error.message}`);
+        throw new Error(`Failed to read ${opts.source} as a file, URL, or Kubernetes CRD`);
     }
-    // Finally, if the source is not a file or URL, try to read it as a CustomResourceDefinition from the cluster
+}
+/**
+ * Resolves the source file path, treating relative paths as local files.
+ *
+ * @param source - The source path to resolve.
+ * @returns The resolved file path.
+ */
+function resolveFilePath(source) {
+    return source.startsWith("/") ? source : path.join(process.cwd(), source);
+}
+/**
+ * Tries to parse the source as a URL.
+ *
+ * @param source - The source string to parse as a URL.
+ * @returns The parsed URL object or null if parsing fails.
+ */
+function tryParseUrl(source) {
     try {
-        logFn(`Attempting to read ${source} from the current Kubernetes context`);
-        return [await (0, fluent_1.K8s)(upstream_1.CustomResourceDefinition).Get(source)];
+        return new URL(source);
     }
-    catch (e) {
-        throw new Error(`Failed to read ${source} as a file, url or K8s CRD: ${e.data?.message || "Cluster not available"}`);
+    catch {
+        return null;
     }
 }
 /**
- * Generate TypeScript types from a K8s CRD
+ * Main generate function to convert CRDs to TypeScript types.
  *
- * @param opts The options to use when generating
- * @returns A promise that resolves when the TypeScript types have been generated
+ * @param opts - The options for generating the TypeScript types.
+ * @returns A promise that resolves to a record of generated TypeScript types.
  */
 async function generate(opts) {
     const crds = (await readOrFetchCrd(opts)).filter(crd => !!crd);
-    const results = {};
+    const allResults = [];
     opts.logFn("");
     for (const crd of crds) {
         if (crd.kind !== "CustomResourceDefinition" || !crd.spec?.versions?.length) {
@@ -181,15 +194,15 @@ async function generate(opts) {
             // 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];
-        }
+        allResults.push(...(await convertCRDtoTS(crd, opts)));
     }
     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`);
+        opts.logFn(`\n✅ Generated ${allResults.length} files in the ${opts.directory} directory`);
+    }
+    else {
+        // Log a message about the number of generated files even when no directory is provided
+        opts.logFn(`\n✅ Generated ${allResults.length} files`);
     }
-    return results;
+    return allResults;
 }