copilot-sdk/java/scripts/codegen/java.ts at main · github/copilot-sdk · GitHub

History

2398 lines (2159 loc) · 102 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

/*---------------------------------------------------------------------------------------------

*--------------------------------------------------------------------------------------------*/

/**

* Java code generator for session-events and RPC types.

* Generates Java source files under sdk/src/generated/java/ from JSON Schema files.

import fs from "fs/promises";

import type { JSONSchema7 } from "json-schema";

import path from "path";

import { fileURLToPath } from "url";

const __filename = fileURLToPath(import.meta.url);

const __dirname = path.dirname(__filename);

/** Root of the copilot-sdk-java repo */

const REPO_ROOT = path.resolve(__dirname, "../..");

/** Event types to exclude from generation (internal/legacy types) */

const EXCLUDED_EVENT_TYPES = new Set(["session.import_legacy"]);

function isSchemaInternal(schema: JSONSchema7 | null | undefined): boolean {

return typeof schema === "object" &&

schema !== null &&

(schema as Record<string, unknown>).visibility === "internal";

}

const AUTO_GENERATED_HEADER = `// AUTO-GENERATED FILE - DO NOT EDIT`;

const GENERATED_FROM_SESSION_EVENTS = `// Generated from: session-events.schema.json`;

const GENERATED_FROM_API = `// Generated from: api.schema.json`;

const GENERATED_ANNOTATION = `@javax.annotation.processing.Generated("copilot-sdk-codegen")`;

const COPYRIGHT = `/*---------------------------------------------------------------------------------------------\n * Copyright (c) Microsoft Corporation. All rights reserved.\n *--------------------------------------------------------------------------------------------*/`;

// ── Naming utilities ─────────────────────────────────────────────────────────

/**

* Correct the GitHub brand casing in a generated identifier or documentation

* string. Schema titles/definition names and value-derived identifiers may

* render the brand as "Github"; the correct casing is "GitHub". Lowercase

* wire/protocol values (e.g. "github") are left untouched. Idempotent.

function fixBrandCasing(value: string): string {

return value.replace(/Github/g, "GitHub");

}

const BRAND_NORMALIZED_STRING_KEYS = new Set(["title", "description", "markdownDescription"]);

/**

* Recursively normalize GitHub brand casing within a parsed JSON schema:

* definition-map keys, `$ref` pointers (definition-name segment only), and

* documentation strings. Wire-level values (`const`, `enum`, `default`, ...) are

* left untouched. Mutates in place and returns the schema.

function normalizeSchemaBrandCasing<T>(schema: T): T {

normalizeBrandCasingNode(schema);

return schema;

}

function normalizeBrandCasingNode(node: unknown): void {

if (Array.isArray(node)) {

for (const item of node) normalizeBrandCasingNode(item);

return;

}

if (node === null || typeof node !== "object") return;

const obj = node as Record<string, unknown>;

if (obj.title === "ProviderModelConfig" && obj.properties && typeof obj.properties === "object") {

const tokenFields = new Set([

"maxPromptTokens",

"maxContextWindowTokens",

"maxOutputTokens",

]);

for (const [key, value] of Object.entries(obj.properties as Record<string, unknown>)) {

if (

tokenFields.has(key) &&

value !== null &&

typeof value === "object" &&

(value as Record<string, unknown>).type === "number"

) {

(value as Record<string, unknown>).type = "integer";

}

for (const defsKey of ["definitions", "$defs"] as const) {

const defs = obj[defsKey];

if (defs && typeof defs === "object" && !Array.isArray(defs)) {

renameBrandDefinitionKeys(defs as Record<string, unknown>);

}

for (const [key, value] of Object.entries(obj)) {

if (typeof value === "string") {

if (key === "$ref") {

obj[key] = fixBrandRef(value);

} else if (BRAND_NORMALIZED_STRING_KEYS.has(key)) {

obj[key] = fixBrandCasing(value);

}

} else {

normalizeBrandCasingNode(value);

}

function fixBrandRef(ref: string): string {

const lastSlash = ref.lastIndexOf("/");

if (lastSlash === -1) return ref;

return `${ref.slice(0, lastSlash + 1)}${fixBrandCasing(ref.slice(lastSlash + 1))}`;

}

function stableStringify(value: unknown): string {

if (Array.isArray(value)) {

return `[${value.map((item) => stableStringify(item)).join(",")}]`;

}

if (value && typeof value === "object") {

const entries = Object.entries(value as Record<string, unknown>).sort(([a], [b]) => a.localeCompare(b));

return `{${entries.map(([key, entryValue]) => `${JSON.stringify(key)}:${stableStringify(entryValue)}`).join(",")}}`;

}

return JSON.stringify(value) ?? "undefined";

}

function renameBrandDefinitionKeys(defs: Record<string, unknown>): void {

for (const oldKey of Object.keys(defs)) {

const newKey = fixBrandCasing(oldKey);

if (newKey === oldKey) continue;

if (newKey in defs && stableStringify(defs[newKey]) !== stableStringify(defs[oldKey])) {

throw new Error(

`Brand-casing normalization collision: "${oldKey}" -> "${newKey}" but a different definition already exists under "${newKey}".`

);

}

defs[newKey] = defs[oldKey];

delete defs[oldKey];

}

function toPascalCase(name: string): string {

return fixBrandCasing(name.split(/[-_.]/).map((p) => p.charAt(0).toUpperCase() + p.slice(1)).join(""));

}

function toJavaClassName(typeName: string): string {

return fixBrandCasing(typeName.split(/[._]/).map((p) => p.charAt(0).toUpperCase() + p.slice(1)).join(""));

}

/** Java reserved keywords and Object method names that cannot be used as record component names. */

const JAVA_RESERVED_IDENTIFIERS = new Set([

"abstract", "assert", "boolean", "break", "byte", "case", "catch", "char", "class", "const",

"continue", "default", "do", "double", "else", "enum", "extends", "final", "finally", "float",

"for", "goto", "if", "implements", "import", "instanceof", "int", "interface", "long", "native",

"new", "package", "private", "protected", "public", "return", "short", "static", "strictfp",

"super", "switch", "synchronized", "this", "throw", "throws", "transient", "try", "void",

"volatile", "while",

// Object methods that conflict with record component accessor names

"wait", "notify", "notifyAll", "getClass", "clone", "finalize", "toString", "hashCode", "equals",

]);

function toCamelCase(name: string): string {

const pascal = toPascalCase(name);

let result = pascal.charAt(0).toLowerCase() + pascal.slice(1);

if (JAVA_RESERVED_IDENTIFIERS.has(result)) {

result = result + "_";

}

return result;

}

function toEnumConstant(value: string): string {

const constant = value.toUpperCase().replace(/[^A-Z0-9]/g, "_").replace(/^_+/, "").replace(/_+/g, "_");

if (constant.length === 0) return "_";

return /^[0-9]/.test(constant) ? `_${constant}` : constant;

}

// ── Schema path resolution ───────────────────────────────────────────────────

/**

* Resolve a JSON schema shipped by the `@github/copilot` CLI package.

* The CLI package layout changed in 1.0.64-1: the umbrella `@github/copilot`

* package became a thin loader and its bundled assets (including the JSON

* schemas) moved into the platform-specific packages installed as optional

* dependencies, e.g. `@github/copilot-linux-x64` or `@github/copilot-win32-x64`.

* We search both the Java codegen install (`scripts/codegen/node_modules`) and

* the Node SDK install (`nodejs/node_modules`), checking the umbrella package

* first (older versions) and then whichever platform package is present.

async function resolveCopilotSchemaPath(fileName: string): Promise<string> {

const nodeModulesDirs = [

path.join(REPO_ROOT, "scripts/codegen/node_modules"),

path.join(REPO_ROOT, "nodejs/node_modules"),

];

const candidates: string[] = [];

for (const nodeModulesDir of nodeModulesDirs) {

candidates.push(path.join(nodeModulesDir, "@github/copilot/schemas", fileName));

const githubScopeDir = path.join(nodeModulesDir, "@github");

try {

for (const entry of await fs.readdir(githubScopeDir)) {

if (entry.startsWith("copilot-")) {

candidates.push(path.join(githubScopeDir, entry, "schemas", fileName));

}

} catch (err) {

const code = (err as NodeJS.ErrnoException).code;

if (code !== "ENOENT" && code !== "ENOTDIR") {

throw err;

}

// @github scope directory may not exist; try the next location.

}

for (const candidate of candidates) {

try {

await fs.access(candidate);

return candidate;

} catch {

// Try the next candidate.

}

throw new Error(`${fileName} not found. Run 'npm ci' in java/scripts/codegen or java/nodejs first.`);

}

async function getSessionEventsSchemaPath(): Promise<string> {

return resolveCopilotSchemaPath("session-events.schema.json");

}

async function getApiSchemaPath(): Promise<string> {

return resolveCopilotSchemaPath("api.schema.json");

}

// ── File writing ─────────────────────────────────────────────────────────────

async function writeGeneratedFile(relativePath: string, content: string): Promise<string> {

const fullPath = path.join(REPO_ROOT, relativePath);

await fs.mkdir(path.dirname(fullPath), { recursive: true });

await fs.writeFile(fullPath, content, "utf-8");

console.log(` ✓ ${relativePath}`);

return fullPath;

}

// ── Java type mapping ─────────────────────────────────────────────────────────

interface JavaTypeResult {

javaType: string;

imports: Set<string>;

}

// Module-level state for $ref resolution during codegen.

// Set before each schema generation pass; used by schemaTypeToJava and helpers.

let currentDefinitions: Record<string, JSONSchema7> = {};

const pendingStandaloneTypes = new Map<string, JSONSchema7>();

const generatedSessionEventTypeNames = new Set<string>();

// Cross-schema definitions: keyed by schema filename (e.g. "session-events.schema.json"),

// value is the definitions map from that schema. Populated by generateRpcTypes so that

// cross-schema $ref values like "session-events.schema.json#/definitions/Foo" can be resolved.

const crossSchemaDefinitions = new Map<string, Record<string, JSONSchema7>>();

/**

* Resolve a $ref in a JSON Schema against the current definitions.

* Returns the resolved schema, or the original if no $ref is present.

function resolveRef(schema: JSONSchema7 | undefined): JSONSchema7 | undefined {

if (!schema) return schema;

if (schema.$ref) {

const name = schema.$ref.replace(/^#\/definitions\//, "");

const resolved = currentDefinitions[name];

if (!resolved) {

console.warn(`[codegen] Unresolved $ref: ${schema.$ref}`);

return schema;

}

return resolved;

}

return schema;

}

function hasOmissionSentinel(schema: JSONSchema7): boolean {

return (schema.anyOf ?? []).some(

(variant) =>

typeof variant === "object"

&& variant !== null

&& typeof (variant as JSONSchema7).not === "object"

&& (variant as JSONSchema7).not !== null

&& Object.keys((variant as JSONSchema7).not as object).length === 0

);

}

/**

* Resolve a method's params schema to the object schema that carries its properties.

* Methods whose params object is entirely optional are published as

* `anyOf: [{ not: {} }, { ...object }]`, so the properties live on a variant

* rather than on the schema itself.

function resolveMethodParamsSchema(method: RpcMethodNode): JSONSchema7 | undefined {

const params = resolveRef(method.params ?? undefined);

if (!params || typeof params !== "object") return undefined;

if (params.properties) return params;

if (!Array.isArray(params.anyOf)) return undefined;

const objectVariants = resolveAnyOfVariants(params.anyOf as JSONSchema7[]).filter((variant) => !!variant.properties);

return hasOmissionSentinel(params) && objectVariants.length === 1 ? objectVariants[0] : undefined;

}

function resolveMethodParamsUnionSchema(method: RpcMethodNode): JSONSchema7 | undefined {

const params = resolveRef(method.params ?? undefined);

if (!params || typeof params !== "object" || !Array.isArray(params.anyOf)) return undefined;

const variants = resolveAnyOfVariants(params.anyOf as JSONSchema7[]);

return variants.length > 1 && findDiscriminator(variants) ? params : undefined;

}

/** Extract the definition name from a $ref string (e.g., "#/definitions/Foo" → "Foo") */

function extractRefName(schema: JSONSchema7 | null | undefined): string | null {

if (!schema?.$ref) return null;

// Handle cross-schema refs

const crossMatch = schema.$ref.match(/^[^#]+#\/definitions\/(.+)$/);

if (crossMatch) return crossMatch[1];

return schema.$ref.replace(/^#\/definitions\//, "");

}

// ── Discriminated union support ─────────────────────────────────────────────

interface DiscriminatorInfo {

property: string;

mapping: Map<string, { value: unknown; schema: JSONSchema7 }>;

}

/**

* Find a discriminator property shared by all variants in an anyOf.

* A discriminator is a property with a `const` value that uniquely identifies each variant.

function findDiscriminator(variants: JSONSchema7[]): DiscriminatorInfo | null {

if (variants.length === 0) return null;

const firstVariant = variants[0];

if (!firstVariant.properties) return null;

for (const [propName, propSchema] of Object.entries(firstVariant.properties).sort(([a], [b]) => a.localeCompare(b))) {

if (typeof propSchema !== "object") continue;

const schema = propSchema as JSONSchema7;

if (schema.const === undefined) continue;

const mapping = new Map<string, { value: unknown; schema: JSONSchema7 }>();

let isValidDiscriminator = true;

for (const variant of variants) {

if (!variant.properties) { isValidDiscriminator = false; break; }

const variantProp = variant.properties[propName];

if (typeof variantProp !== "object") { isValidDiscriminator = false; break; }

const variantSchema = variantProp as JSONSchema7;

if (variantSchema.const === undefined) { isValidDiscriminator = false; break; }

const key = String(variantSchema.const);

if (mapping.has(key)) { isValidDiscriminator = false; break; }

mapping.set(key, { value: variantSchema.const, schema: variant });

}

if (isValidDiscriminator && mapping.size === variants.length) {

return { property: propName, mapping };

}

return null;

}

/**

* Resolve anyOf variants, handling $ref to definitions.

function resolveAnyOfVariants(anyOf: JSONSchema7[]): JSONSchema7[] {

return anyOf

.map((v) => {

if (v.$ref) {

const name = v.$ref.replace(/^#\/definitions\//, "");

return currentDefinitions[name] ?? v;

}

return v;

})

.filter((v) => v.type !== "null");

}

/**

* Generate a polymorphic base class and variant subclasses for a discriminated union result type.

async function generatePolymorphicResultClass(

className: string,

schema: JSONSchema7,

packageName: string,

packageDir: string

): Promise<void> {

const anyOf = schema.anyOf as JSONSchema7[];

const variants = resolveAnyOfVariants(anyOf);

const discriminator = findDiscriminator(variants);

if (!discriminator) {

console.warn(`[codegen] Cannot find discriminator for ${className} — skipping polymorphic generation`);

return;

}

// Collect variant info

interface VariantInfo {

discriminatorValue: string;

variantClassName: string;

schema: JSONSchema7;

}

const variantInfos: VariantInfo[] = [];

for (const [discValue, { schema: variantSchema }] of discriminator.mapping) {

const variantClassName = (variantSchema as JSONSchema7 & { title?: string }).title ?? `${className}${toPascalCase(discValue)}`;

variantInfos.push({ discriminatorValue: discValue, variantClassName, schema: variantSchema });

}

// Generate the abstract base class

const baseLines: string[] = [];

baseLines.push(COPYRIGHT);

baseLines.push("");

baseLines.push(AUTO_GENERATED_HEADER);

baseLines.push(GENERATED_FROM_API);

baseLines.push("");

baseLines.push(`package ${packageName};`);

baseLines.push("");

baseLines.push(`import com.fasterxml.jackson.annotation.JsonIgnoreProperties;`);

baseLines.push(`import com.fasterxml.jackson.annotation.JsonSubTypes;`);

baseLines.push(`import com.fasterxml.jackson.annotation.JsonTypeInfo;`);

baseLines.push(`import javax.annotation.processing.Generated;`);

baseLines.push("");

if (schema.description) {

baseLines.push(`/**`);

baseLines.push(` * ${schema.description}`);

baseLines.push(` *`);

baseLines.push(` * @since 1.0.0`);

baseLines.push(` */`);

}

baseLines.push(`@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "${discriminator.property}", visible = true)`);

baseLines.push(`@JsonSubTypes({`);

for (let i = 0; i < variantInfos.length; i++) {

const v = variantInfos[i];

const comma = i < variantInfos.length - 1 ? "," : "";

baseLines.push(` @JsonSubTypes.Type(value = ${v.variantClassName}.class, name = "${v.discriminatorValue}")${comma}`);

}

baseLines.push(`})`);

baseLines.push(`@JsonIgnoreProperties(ignoreUnknown = true)`);

baseLines.push(GENERATED_ANNOTATION);

baseLines.push(`public abstract class ${className} {`);

baseLines.push("");

baseLines.push(` /**`);

baseLines.push(` * Returns the discriminator value for this variant.`);

baseLines.push(` *`);

baseLines.push(` * @return the ${discriminator.property} discriminator`);

baseLines.push(` */`);

baseLines.push(` public abstract String get${toPascalCase(discriminator.property)}();`);

baseLines.push(`}`);

baseLines.push("");

await writeGeneratedFile(`${packageDir}/${className}.java`, baseLines.join("\n"));

// Generate each variant subclass

for (const variant of variantInfos) {

await generatePolymorphicVariantClass(variant.variantClassName, variant.schema, variant.discriminatorValue, discriminator.property, className, packageName, packageDir);

}

/**

* Generate a single variant subclass of a polymorphic result type.

async function generatePolymorphicVariantClass(

className: string,

schema: JSONSchema7,

discriminatorValue: string,

discriminatorProperty: string,

baseClassName: string,

packageName: string,

packageDir: string

): Promise<void> {

const allImports = new Set<string>([

"com.fasterxml.jackson.annotation.JsonIgnoreProperties",

"com.fasterxml.jackson.annotation.JsonInclude",

"com.fasterxml.jackson.annotation.JsonProperty",

"javax.annotation.processing.Generated",

]);

const nestedTypes = new Map<string, JavaClassDef>();

// Collect fields (excluding the discriminator property)

interface FieldInfo {

jsonName: string;

javaName: string;

javaType: string;

description?: string;

}

const fields: FieldInfo[] = [];

if (schema.properties) {

for (const [propName, propSchema] of Object.entries(schema.properties)) {

if (propName === discriminatorProperty) continue;

if (typeof propSchema !== "object") continue;

const prop = propSchema as JSONSchema7;

const result = schemaTypeToJava(prop, false, className, propName, nestedTypes);

for (const imp of result.imports) allImports.add(imp);

fields.push({

jsonName: propName,

javaName: toCamelCase(propName),

javaType: result.javaType,

description: prop.description,

});

}

const lines: string[] = [];

lines.push(COPYRIGHT);

lines.push("");

lines.push(AUTO_GENERATED_HEADER);

lines.push(GENERATED_FROM_API);

lines.push("");

lines.push(`package ${packageName};`);

lines.push("");

// Placeholder for imports

const importPlaceholderIdx = lines.length;

lines.push("__IMPORTS__");

lines.push("");

if (schema.description) {

lines.push(`/**`);

lines.push(` * ${schema.description}`);

lines.push(` *`);

lines.push(` * @since 1.0.0`);

lines.push(` */`);

} else {

lines.push(`/**`);

lines.push(` * Variant {@code ${discriminatorValue}} of {@link ${baseClassName}}.`);

lines.push(` *`);

lines.push(` * @since 1.0.0`);

lines.push(` */`);

}

lines.push(`@JsonIgnoreProperties(ignoreUnknown = true)`);

lines.push(`@JsonInclude(JsonInclude.Include.NON_NULL)`);

lines.push(GENERATED_ANNOTATION);

lines.push(`public final class ${className} extends ${baseClassName} {`);

lines.push("");

// Discriminator field

lines.push(` @JsonProperty("${discriminatorProperty}")`);

lines.push(` private final String ${toCamelCase(discriminatorProperty)} = "${discriminatorValue}";`);

lines.push("");

lines.push(` @Override`);

lines.push(` public String get${toPascalCase(discriminatorProperty)}() { return ${toCamelCase(discriminatorProperty)}; }`);

lines.push("");

// Other fields

for (const field of fields) {

if (field.description) {

lines.push(` /** ${field.description} */`);

}

lines.push(` @JsonProperty("${field.jsonName}")`);

lines.push(` private ${field.javaType} ${field.javaName};`);

lines.push("");

}

// Getters and setters

for (const field of fields) {

lines.push(` public ${field.javaType} get${field.javaName.charAt(0).toUpperCase() + field.javaName.slice(1)}() { return ${field.javaName}; }`);

lines.push(` public void set${field.javaName.charAt(0).toUpperCase() + field.javaName.slice(1)}(${field.javaType} ${field.javaName}) { this.${field.javaName} = ${field.javaName}; }`);

lines.push("");

}

// Render nested types

for (const [, nested] of nestedTypes) {

lines.push(...renderNestedType(nested, 1, new Map(), allImports));

}

if (lines[lines.length - 1] === "") lines.pop();

lines.push(`}`);

lines.push("");

// Replace import placeholder

const sortedImports = [...allImports].sort();

const importLines = sortedImports.map((i) => `import ${i};`).join("\n");

lines[importPlaceholderIdx] = importLines;

await writeGeneratedFile(`${packageDir}/${className}.java`, lines.join("\n"));

}

function schemaTypeToJava(

schema: JSONSchema7,

required: boolean,

context: string,

propName: string,

nestedTypes: Map<string, JavaClassDef>

): JavaTypeResult {

const imports = new Set<string>();

// Resolve $ref first — register standalone types for generation

if (schema.$ref) {

// Handle cross-schema $ref (e.g. "session-events.schema.json#/definitions/Foo")

const crossSchemaMatch = schema.$ref.match(/^([^#]+)#\/definitions\/(.+)$/);

if (crossSchemaMatch) {

const [, schemaFile, typeName] = crossSchemaMatch;

const externalDefs = crossSchemaDefinitions.get(schemaFile);

if (

schemaFile === "session-events.schema.json"

&& externalDefs?.[typeName]

&& generatedSessionEventTypeNames.has(typeName)

) {

imports.add(`com.github.copilot.generated.${typeName}`);

return { javaType: typeName, imports };

}

return { javaType: "Object", imports };

}

const name = schema.$ref.replace(/^#\/definitions\//, "");

const resolved = currentDefinitions[name];

if (resolved) {

// Enum or object types → register for standalone generation, return ref name

if ((resolved.type === "string" && resolved.enum) ||

(resolved.type === "object" && resolved.properties)) {

pendingStandaloneTypes.set(name, resolved);

return { javaType: name, imports };

}

// Other types (primitives, arrays, maps, anyOf unions) → resolve and recurse

return schemaTypeToJava(resolved, required, context, propName, nestedTypes);

}

// Unresolved $ref — return name as-is

console.warn(`[codegen] Unresolved $ref: ${schema.$ref}`);

return { javaType: name, imports };

}

if (schema.anyOf) {

const hasNull = schema.anyOf.some((s) => typeof s === "object" && (s as JSONSchema7).type === "null");

const nonNull = schema.anyOf.filter((s) => typeof s === "object" && (s as JSONSchema7).type !== "null");

if (nonNull.length === 1) {

const result = schemaTypeToJava(nonNull[0] as JSONSchema7, required && !hasNull, context, propName, nestedTypes);

return result;

}

// Multi-branch anyOf: fall through to Object, matching the C# generator's

// behavior. Java has no union types, so Object is the correct erasure for

// anyOf[string, object] and similar multi-variant schemas.

console.warn(`[codegen] ${context}.${propName}: anyOf with ${nonNull.length} non-null branches — falling back to Object`);

return { javaType: "Object", imports };

}

if (schema.type === "string") {

if (schema.format === "uuid") {

imports.add("java.util.UUID");

return { javaType: "UUID", imports };

}

if (schema.format === "date-time") {

imports.add("java.time.OffsetDateTime");

return { javaType: "OffsetDateTime", imports };

}

if (schema.enum && Array.isArray(schema.enum)) {

const enumName = `${context}${toPascalCase(propName)}`;

nestedTypes.set(enumName, {

kind: "enum",

values: schema.enum as string[],

description: schema.description,

});

return { javaType: enumName, imports };

}

return { javaType: "String", imports };

}

if (Array.isArray(schema.type)) {

const nonNullTypes = schema.type.filter((t) => t !== "null");

if (nonNullTypes.length === 1) {

const baseSchema = { ...schema, type: nonNullTypes[0] };

return schemaTypeToJava(baseSchema as JSONSchema7, required, context, propName, nestedTypes);

}

if (schema.type === "integer") {

// JSON Schema "integer" maps to Long (boxed — always used for records).

// Use primitive long for required fields in mutable-bean contexts if needed.

return { javaType: required ? "long" : "Long", imports };

}

if (schema.type === "number") {

return { javaType: required ? "double" : "Double", imports };

}

if (schema.type === "boolean") {

return { javaType: required ? "boolean" : "Boolean", imports };

}

if (schema.type === "array") {

const items = schema.items as JSONSchema7 | undefined;

if (items) {

// Always pass required=false so primitives are boxed (List<Long>, not List<long>)

const itemResult = schemaTypeToJava(items, false, context, propName + "Item", nestedTypes);

imports.add("java.util.List");

for (const imp of itemResult.imports) imports.add(imp);

return { javaType: `List<${itemResult.javaType}>`, imports };

}

imports.add("java.util.List");

console.warn(`[codegen] ${context}.${propName}: array without typed items — falling back to List<Object>`);

return { javaType: "List<Object>", imports };

}

if (schema.type === "object") {

if (schema.properties && Object.keys(schema.properties).length > 0) {

const nestedName = `${context}${toPascalCase(propName)}`;

if (!nestedTypes.has(nestedName)) {

nestedTypes.set(nestedName, {

kind: "class",

schema,

description: schema.description,

});

}

return { javaType: nestedName, imports };

}

if (schema.additionalProperties) {

const valueSchema = typeof schema.additionalProperties === "object"

? schema.additionalProperties as JSONSchema7

: { type: "object" } as JSONSchema7;

// Always pass required=false so primitives are boxed (Map<String, Long>, not Map<String, long>)

const valueResult = schemaTypeToJava(valueSchema, false, context, propName + "Value", nestedTypes);

imports.add("java.util.Map");

for (const imp of valueResult.imports) imports.add(imp);

return { javaType: `Map<String, ${valueResult.javaType}>`, imports };

}

imports.add("java.util.Map");

console.warn(`[codegen] ${context}.${propName}: object without typed properties or additionalProperties — falling back to Map<String, Object>`);

return { javaType: "Map<String, Object>", imports };

}

console.warn(`[codegen] ${context}.${propName}: unrecognized schema (type=${JSON.stringify(schema.type)}) — falling back to Object`);

return { javaType: "Object", imports };

}

// ── Class definitions ─────────────────────────────────────────────────────────

interface JavaClassDef {

kind: "class" | "enum";

description?: string;

schema?: JSONSchema7;

values?: string[]; // for enum

}

// ── Session Events codegen ────────────────────────────────────────────────────

interface EventVariant {

typeName: string;

className: string;

dataSchema: JSONSchema7 | null;

description?: string;

stability?: string;

deprecated?: boolean;

}

function extractEventVariants(schema: JSONSchema7): EventVariant[] {

const definitions = schema.definitions as Record<string, JSONSchema7>;

const sessionEvent = definitions?.SessionEvent;

if (!sessionEvent?.anyOf) throw new Error("Schema must have SessionEvent definition with anyOf");

return (sessionEvent.anyOf as JSONSchema7[])

.map((variant) => {

// Resolve $ref if present (1.0.35+ schema uses $ref to named definitions)

let resolved = variant;

if (variant.$ref) {

const refName = variant.$ref.replace(/^#\/definitions\//, "");

resolved = definitions[refName];

if (!resolved) throw new Error(`Unresolved $ref: ${variant.$ref}`);

}

const typeSchema = resolved.properties?.type as JSONSchema7;

const typeName = typeSchema?.const as string;

if (!typeName) throw new Error("Variant must have type.const");

const baseName = toJavaClassName(typeName);

let dataSchema = resolved.properties?.data as JSONSchema7 | undefined;

// Resolve $ref on data schema if present

if (dataSchema?.$ref) {

const dataRefName = dataSchema.$ref.replace(/^#\/definitions\//, "");

dataSchema = definitions[dataRefName];

}

return {

typeName,

className: `${baseName}Event`,

dataSchema: dataSchema ?? null,

description: resolved.description,

stability: (variant as unknown as Record<string, unknown>).stability as string | undefined,

deprecated: (variant as unknown as Record<string, unknown>).deprecated === true,

};

})

.filter((v) => !EXCLUDED_EVENT_TYPES.has(v.typeName) && !isSchemaInternal(v.dataSchema));

}

async function generateSessionEvents(schemaPath: string): Promise<void> {

console.log("\n📋 Generating session event classes...");

const schemaContent = await fs.readFile(schemaPath, "utf-8");

const schema = normalizeSchemaBrandCasing(JSON.parse(schemaContent) as JSONSchema7);

// Set module-level definitions for $ref resolution

currentDefinitions = (schema.definitions ?? {}) as Record<string, JSONSchema7>;

pendingStandaloneTypes.clear();

const variants = extractEventVariants(schema);

const packageName = "com.github.copilot.generated";

const packageDir = `sdk/src/generated/java/com/github/copilot/generated`;

// Generate base SessionEvent class

await generateSessionEventBaseClass(variants, packageName, packageDir);

// Generate one class file per event variant

for (const variant of variants) {

await generateEventVariantClass(variant, packageName, packageDir);

}

// Generate standalone types discovered via $ref resolution

await generatePendingStandaloneTypes(packageName, packageDir, GENERATED_FROM_SESSION_EVENTS);

generatedSessionEventTypeNames.clear();

for (const entry of await fs.readdir(path.join(REPO_ROOT, packageDir), { withFileTypes: true })) {

if (entry.isFile() && entry.name.endsWith(".java")) {

generatedSessionEventTypeNames.add(path.basename(entry.name, ".java"));

}

console.log(`✅ Generated ${variants.length + 1} session event files`);

}

async function generateSessionEventBaseClass(

variants: EventVariant[],

packageName: string,

packageDir: string

): Promise<void> {

const lines: string[] = [];

lines.push(COPYRIGHT);

lines.push("");

lines.push(AUTO_GENERATED_HEADER);

lines.push(GENERATED_FROM_SESSION_EVENTS);

lines.push("");

lines.push(`package ${packageName};`);

lines.push("");

lines.push(`import com.fasterxml.jackson.annotation.JsonIgnoreProperties;`);

lines.push(`import com.fasterxml.jackson.annotation.JsonInclude;`);

lines.push(`import com.fasterxml.jackson.annotation.JsonProperty;`);

lines.push(`import com.fasterxml.jackson.annotation.JsonSubTypes;`);

lines.push(`import com.fasterxml.jackson.annotation.JsonTypeInfo;`);

lines.push(`import java.time.OffsetDateTime;`);

lines.push(`import java.util.UUID;`);

lines.push(`import javax.annotation.processing.Generated;`);

lines.push("");

lines.push(`/**`);

lines.push(` * Base class for all generated session events.`);

lines.push(` *`);

lines.push(` * @since 1.0.0`);

lines.push(` */`);

lines.push(`@JsonIgnoreProperties(ignoreUnknown = true)`);

lines.push(`@JsonInclude(JsonInclude.Include.NON_NULL)`);

lines.push(`@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type", visible = true, defaultImpl = UnknownSessionEvent.class)`);

lines.push(`@JsonSubTypes({`);

for (let i = 0; i < variants.length; i++) {

const v = variants[i];

const comma = i < variants.length - 1 ? "," : "";

lines.push(` @JsonSubTypes.Type(value = ${v.className}.class, name = "${v.typeName}")${comma}`);

}

lines.push(`})`);

lines.push(GENERATED_ANNOTATION);

// Build the permits clause (all variant classes + UnknownSessionEvent last)

const allPermitted = [...variants.map((v) => v.className), "UnknownSessionEvent"];

lines.push(`public abstract sealed class SessionEvent permits`);

for (let i = 0; i < allPermitted.length; i++) {

const comma = i < allPermitted.length - 1 ? "," : " {";

lines.push(` ${allPermitted[i]}${comma}`);

}

lines.push("");

lines.push(` /** Unique event identifier (UUID v4), generated when the event is emitted. */`);

lines.push(` @JsonProperty("id")`);

lines.push(` private UUID id;`);

lines.push("");

lines.push(` /** ISO 8601 timestamp when the event was created. */`);

lines.push(` @JsonProperty("timestamp")`);

lines.push(` private OffsetDateTime timestamp;`);

lines.push("");

lines.push(` /** ID of the chronologically preceding event in the session. Null for the first event. */`);

lines.push(` @JsonProperty("parentId")`);

lines.push(` private UUID parentId;`);

lines.push("");

lines.push(` /** Sub-agent instance identifier. Absent for events from the root/main agent and session-level events. */`);

lines.push(` @JsonProperty("agentId")`);

lines.push(` private String agentId;`);

lines.push("");

lines.push(` /** When true, the event is transient and not persisted to the session event log on disk. */`);

lines.push(` @JsonProperty("ephemeral")`);

lines.push(` private Boolean ephemeral;`);

lines.push("");

lines.push(` /**`);

lines.push(` * Returns the event-type discriminator string (e.g., {@code "session.idle"}).`);

lines.push(` *`);

lines.push(` * @return the event type`);

lines.push(` */`);

lines.push(` public abstract String getType();`);

lines.push("");

lines.push(` public UUID getId() { return id; }`);

lines.push(` public void setId(UUID id) { this.id = id; }`);

lines.push("");

lines.push(` public OffsetDateTime getTimestamp() { return timestamp; }`);

lines.push(` public void setTimestamp(OffsetDateTime timestamp) { this.timestamp = timestamp; }`);

lines.push("");

lines.push(` public UUID getParentId() { return parentId; }`);

lines.push(` public void setParentId(UUID parentId) { this.parentId = parentId; }`);

lines.push("");

lines.push(` public String getAgentId() { return agentId; }`);

lines.push(` public void setAgentId(String agentId) { this.agentId = agentId; }`);

lines.push("");

lines.push(` public Boolean getEphemeral() { return ephemeral; }`);

lines.push(` public void setEphemeral(Boolean ephemeral) { this.ephemeral = ephemeral; }`);

lines.push(`}`);

lines.push("");

await writeGeneratedFile(`${packageDir}/SessionEvent.java`, lines.join("\n"));

// Also generate the UnknownSessionEvent fallback

await generateUnknownEventClass(packageName, packageDir);

}

async function generateUnknownEventClass(packageName: string, packageDir: string): Promise<void> {

const lines: string[] = [];

lines.push(COPYRIGHT);

lines.push("");

lines.push(AUTO_GENERATED_HEADER);

lines.push(GENERATED_FROM_SESSION_EVENTS);

lines.push("");

lines.push(`package ${packageName};`);

lines.push("");

lines.push(`import com.fasterxml.jackson.annotation.JsonIgnoreProperties;`);

lines.push(`import com.fasterxml.jackson.annotation.JsonProperty;`);

lines.push(`import javax.annotation.processing.Generated;`);

lines.push("");

lines.push(`/**`);

lines.push(` * Fallback for event types not yet known to this SDK version.`);

lines.push(` * <p>`);

lines.push(` * {@link #getType()} returns the original type string from the JSON payload,`);

lines.push(` * preserving forward compatibility with event types introduced by newer CLI versions.`);

lines.push(` *`);

lines.push(` * @since 1.0.0`);

lines.push(` */`);

lines.push(`@JsonIgnoreProperties(ignoreUnknown = true)`);

lines.push(GENERATED_ANNOTATION);

lines.push(`public final class UnknownSessionEvent extends SessionEvent {`);

lines.push("");

lines.push(` @JsonProperty("type")`);

lines.push(` private String type = "unknown";`);

lines.push("");

lines.push(` @Override`);

lines.push(` public String getType() { return type; }`);

lines.push(`}`);

lines.push("");

await writeGeneratedFile(`${packageDir}/UnknownSessionEvent.java`, lines.join("\n"));

}

/** Render a nested type (enum or record) indented at the given level. */

function renderNestedType(nested: JavaClassDef, indentLevel: number, nestedTypes: Map<string, JavaClassDef>, allImports: Set<string>): string[] {

const ind = " ".repeat(indentLevel);

const lines: string[] = [];

if (nested.kind === "enum") {

lines.push("");

if (nested.description) {

lines.push(`${ind}/** ${nested.description} */`);

}

lines.push(`${ind}public enum ${nested.name} {`);

for (let i = 0; i < (nested.values || []).length; i++) {

const v = nested.values![i];

const comma = i < nested.values!.length - 1 ? "," : ";";

lines.push(`${ind} /** The {@code ${v}} variant. */`);

lines.push(`${ind} ${toEnumConstant(v)}("${v}")${comma}`);

}

lines.push("");

lines.push(`${ind} private final String value;`);

lines.push(`${ind} ${nested.name}(String value) { this.value = value; }`);

lines.push(`${ind} @com.fasterxml.jackson.annotation.JsonValue`);

lines.push(`${ind} public String getValue() { return value; }`);

lines.push(`${ind} @com.fasterxml.jackson.annotation.JsonCreator`);

lines.push(`${ind} public static ${nested.name} fromValue(String value) {`);

lines.push(`${ind} for (${nested.name} v : values()) {`);

lines.push(`${ind} if (v.value.equals(value)) return v;`);

lines.push(`${ind} }`);

lines.push(`${ind} throw new IllegalArgumentException("Unknown ${nested.name} value: " + value);`);

lines.push(`${ind} }`);

lines.push(`${ind}}`);

} else if (nested.kind === "class" && nested.schema?.properties) {

const localNestedTypes = new Map<string, JavaClassDef>();

const fields: { jsonName: string; javaName: string; javaType: string; description?: string }[] = [];

for (const [propName, propSchema] of Object.entries(nested.schema.properties)) {

if (typeof propSchema !== "object") continue;

const prop = propSchema as JSONSchema7;

// Record components are always boxed (nullable by design).

const result = schemaTypeToJava(prop, false, nested.name, propName, localNestedTypes);

for (const imp of result.imports) allImports.add(imp);

fields.push({ jsonName: propName, javaName: toCamelCase(propName), javaType: result.javaType, description: prop.description });

}

lines.push("");

if (nested.description) {

lines.push(`${ind}/** ${nested.description} */`);

}

lines.push(`${ind}@JsonIgnoreProperties(ignoreUnknown = true)`);

View remainder of file in raw view

copilot-sdk/java/scripts/codegen/java.ts at main · github/copilot-sdk · GitHub

Navigation Menu

Uh oh!

copilot-sdk/java/scripts/codegen/java.ts at main · github/copilot-sdk · GitHub

Navigation Menu

Uh oh!

Expand file tree

Breadcrumbs

java.ts

Latest commit

History

Breadcrumbs

java.ts

File metadata and controls

Footer

Footer navigation