initial setup for bind gvk to k8s client #10

Anmol1696 · 2025-09-12T04:52:01Z

Get a registry of sorts setup for the clients and operations

Closes: #11
Closes: #9

Copilot

Pull Request Overview

Adds GVK (Group/Version/Kind) to Kubernetes client binding functionality by introducing a registry system that maps Kubernetes resources to their generated client methods and types.

Adds opsIndex configuration option to enable GVK-based operations registry
Implements qualified type naming strategy to handle resource name conflicts
Generates ResourceTypeMap and utility types for type-safe GVK operations

Reviewed Changes

Copilot reviewed 3 out of 11 changed files in this pull request and generated 7 comments.

File	Description
packages/schema-sdk/src/types.ts	Adds `opsIndex` configuration options for GVK registry generation
packages/schema-sdk/src/openapi.ts	Implements GVK-based type naming, interface renaming, and registry generation logic
packages/schema-sdk/tests/openapi.extended.generate.test.ts	Adds test cases for GVK functionality and qualified naming strategy

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-24T14:47:13Z

packages/schema-sdk/src/openapi.ts

+  options: OpenAPIOptions
+): string => {
+  const { group, version, kind } = gvk;
+


[nitpick] Extra blank line should be removed for consistent formatting.

Suggested change

Copilot · 2025-09-24T14:47:13Z

packages/schema-sdk/src/openapi.ts

+  options: OpenAPIOptions
+): string => {
+  const { group, version, kind } = gvk;
+


[nitpick] Extra blank line should be removed for consistent formatting.

Suggested change

Copilot · 2025-09-24T14:47:14Z

packages/schema-sdk/src/openapi.ts

+  const groupParts = group.split('.').map(part => toPascalCase(part)).join('');
+  const versionPart = toPascalCase(version);
+  const qualifiedName = `${groupParts}${versionPart}${toPascalCase(kind)}`;
+


[nitpick] Extra blank line should be removed for consistent formatting.

Suggested change

Copilot · 2025-09-24T14:47:14Z

packages/schema-sdk/src/openapi.ts

+      // @ts-ignore
+      const operation: Operation = (pathItem as any)[m];


Use proper type assertion instead of @ts-ignore. Consider using (pathItem as any)[m] as Operation | undefined and handle the undefined case explicitly.

Suggested change

// @ts-ignore

const operation: Operation = (pathItem as any)[m];

const operation = (pathItem as any)[m] as Operation | undefined;

Copilot · 2025-09-24T14:47:14Z

packages/schema-sdk/src/openapi.ts

+      // @ts-ignore
+      const operation: Operation = (pathItem as any)[m];


Use proper type assertion instead of @ts-ignore. Consider using (pathItem as any)[m] as Operation | undefined and handle the undefined case explicitly.

Suggested change

// @ts-ignore

const operation: Operation = (pathItem as any)[m];

// Use proper type assertion instead of @ts-ignore

const operation = (pathItem as any)[m] as Operation | undefined;

Copilot · 2025-09-24T14:47:15Z

packages/schema-sdk/src/openapi.ts

+      // @ts-ignore
+      const operation: Operation = (pathItem as any)[m];


Use proper type assertion instead of @ts-ignore. Consider using (pathItem as any)[m] as Operation | undefined and handle the undefined case explicitly.

Suggested change

// @ts-ignore

const operation: Operation = (pathItem as any)[m];

const operation = (pathItem as any)[m] as Operation | undefined;

Copilot · 2025-09-24T14:47:15Z

packages/schema-sdk/src/openapi.ts

+      // @ts-ignore
+      const operation: Operation = (pathItem as any)[m];


Use proper type assertion instead of @ts-ignore. Consider using (pathItem as any)[m] as Operation | undefined and handle the undefined case explicitly.

Suggested change

// @ts-ignore

const operation: Operation = (pathItem as any)[m];

const operation = (pathItem as any)[m] as Operation | undefined;

Copilot

Pull Request Overview

Copilot reviewed 4 out of 12 changed files in this pull request and generated 5 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-24T17:21:38Z

packages/schema-sdk/src/openapi.ts

 ) => {
-  // @ts-ignore
-  const operation: Operation = pathItem[method];
+  const operation: Operation | undefined = pathItem[method];


The type assertion is incorrect. pathItem[method] should be cast as pathItem[method as keyof OpenAPIPathItem] as Operation | undefined to properly access the method property on the pathItem object.

Suggested change

const operation: Operation | undefined = pathItem[method];

const operation: Operation | undefined = pathItem[method as keyof OpenAPIPathItem] as Operation | undefined;

Copilot · 2025-09-24T17:21:38Z

packages/schema-sdk/src/openapi.ts

-        // @ts-ignore
-        const operation: Operation = pathItem[method];
-        if (!shouldIncludeOperation(options, pathItem, path, method as any))
+        const operation: Operation | undefined = pathItem[method as keyof OpenAPIPathItem] as Operation | undefined;


[nitpick] This type assertion pattern is repeated multiple times throughout the file. Consider extracting this into a helper function like getOperationFromPathItem(pathItem: OpenAPIPathItem, method: string): Operation | undefined to reduce duplication and improve maintainability.

Copilot · 2025-09-24T17:21:38Z

packages/schema-sdk/src/openapi.ts

+  const { group, version, kind } = gvk;
+
+  // Handle core group (empty group) and normalize group names
+  const groupName = group === '' ? 'Core' : toPascalCase(group.replace(/\./g, ''));


The magic string 'Core' is hardcoded here but should use the configurable emptyGroupLabel from options. This creates inconsistency with the configurable label used elsewhere in the code.

Suggested change

const groupName = group === '' ? 'Core' : toPascalCase(group.replace(/\./g, ''));

const groupName = group === '' ? (options.emptyGroupLabel || 'Core') : toPascalCase(group.replace(/\./g, ''));

Copilot · 2025-09-24T17:21:39Z

packages/schema-sdk/src/openapi.ts

+  gvk: { group: string; version: string; kind: string };
+  scope: 'Namespaced' | 'Cluster' | 'Unknown';
+  types: { main: string; list?: string };
+  ops: any; // OperationSpec-ish


Using any type defeats the purpose of TypeScript's type safety. Define a proper interface for the operations specification or use a more specific type like Record<string, unknown> if the structure is truly variable.

Suggested change

ops: any; // OperationSpec-ish

ops: Record<string, unknown>; // OperationSpec-ish

Copilot · 2025-09-24T17:21:39Z

packages/schema-sdk/src/openapi.ts

+  code = code.replace(
+    /export type KubernetesResource = ([^;]+);/,
+    (full, types) => {
+      const parts = types
+        .split('|')
+        .map((part: string) => part.trim())
+        .filter(Boolean);
+      if (parts.length <= 1) {
+        return full;
+      }
+      const union = parts.map((part: string) => `  | ${part}`).join('\n');
+      return `export type KubernetesResource =\n${union};`;
+    }
+  );


[nitpick] Using regex string replacement on generated code is fragile and error-prone. Consider generating the union type directly in the AST generation phase instead of post-processing the string output.

Suggested change

code = code.replace(

/export type KubernetesResource = ([^;]+);/,

(full, types) => {

const parts = types

.split('|')

.map((part: string) => part.trim())

.filter(Boolean);

if (parts.length <= 1) {

return full;

}

const union = parts.map((part: string) => ` | ${part}`).join('\n');

return `export type KubernetesResource =\n${union};`;

}

);

// The KubernetesResource union type should be generated in multi-line format directly in the AST phase.

Anmol1696 added 4 commits September 12, 2025 08:51

initial setup for bind gvk to k8s client

fe246da

update how to use resouces being created

d5ca09e

add resource map and fix naming conflicts as well

0153d3b

update snapshot f

0a25a4f

Anmol1696 requested review from Copilot and pyramation September 24, 2025 14:45

Copilot AI reviewed Sep 24, 2025

View reviewed changes

update file to fix ts-ignore errors

1e1aec4

Anmol1696 requested a review from Copilot September 24, 2025 17:20

Copilot AI reviewed Sep 24, 2025

View reviewed changes

Anmol1696 added 2 commits September 24, 2025 21:33

update kubernetesresource to be babel instead of string

f352912

update snapshot

fb3a479

Anmol1696 merged commit 5e662c7 into main Sep 24, 2025
1 check passed

Anmol1696 deleted the anmol/bind-gkv branch September 24, 2025 17:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

initial setup for bind gvk to k8s client #10

initial setup for bind gvk to k8s client #10

Uh oh!

Anmol1696 commented Sep 12, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Copilot AI Sep 24, 2025

Uh oh!

Uh oh!

Uh oh!

		// @ts-ignore
		const operation: Operation = (pathItem as any)[m];

	// @ts-ignore
	const operation: Operation = (pathItem as any)[m];
	const operation = (pathItem as any)[m] as Operation \| undefined;

	const operation: Operation \| undefined = pathItem[method];
	const operation: Operation \| undefined = pathItem[method as keyof OpenAPIPathItem] as Operation \| undefined;

	const groupName = group === '' ? 'Core' : toPascalCase(group.replace(/\./g, ''));
	const groupName = group === '' ? (options.emptyGroupLabel \|\| 'Core') : toPascalCase(group.replace(/\./g, ''));

	ops: any; // OperationSpec-ish
	ops: Record<string, unknown>; // OperationSpec-ish

initial setup for bind gvk to k8s client #10

initial setup for bind gvk to k8s client #10

Uh oh!

Conversation

Anmol1696 commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Anmol1696 commented Sep 12, 2025 •

edited

Loading