Skip to content

Generate index files for nested clients #3734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JialinHuang803 merged 9 commits into from
Feb 12, 2026
Merged

Generate index files for nested clients #3734

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a83b224
Initial plan
Copilot Feb 10, 2026
1e40801
Add expected blob/index.ts file to demonstrate the fix
Copilot Feb 10, 2026
619608c
Smoke test passed with blob/index.ts
Copilot Feb 10, 2026
ab4a697
All tests passing - fix complete
Copilot Feb 10, 2026
2e52080
Simplify condition check as per code review feedback
Copilot Feb 10, 2026
ee8a1d5
Fix naming consistency for exported types in blob/index.ts
Copilot Feb 10, 2026
0b809ca
Add clarifying comment for subfolder condition check
Copilot Feb 10, 2026
107b86c
Address PR feedback: revert manual changes and simplify condition
Copilot Feb 12, 2026
3052802
Merge branch 'main' into copilot/fix-missing-index-file-nested-client
JialinHuang803 Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions packages/typespec-test/test/nestedClient/generated/typespec-ts/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"exports": {
"./package.json": "./package.json",
".": "./src/index.ts",
"./models": "./src/models/index.ts",
"./api": "./src/api/index.ts",
"./blob": "./src/blob/index.ts",
"./blob/api": "./src/blob/api/index.ts"
Expand Down Expand Up @@ -90,6 +91,24 @@
"default": "./dist/commonjs/index.js"
}
},
"./models": {
"browser": {
"types": "./dist/browser/models/index.d.ts",
"default": "./dist/browser/models/index.js"
},
"react-native": {
"types": "./dist/react-native/models/index.d.ts",
"default": "./dist/react-native/models/index.js"
},
"import": {
"types": "./dist/esm/models/index.d.ts",
"default": "./dist/esm/models/index.js"
},
"require": {
"types": "./dist/commonjs/models/index.d.ts",
"default": "./dist/commonjs/models/index.js"
}
},
"./api": {
"browser": {
"types": "./dist/browser/api/index.d.ts",
Expand Down
5 changes: 5 additions & 0 deletions packages/typespec-test/test/nestedClient/generated/typespec-ts/src/blob/index.ts
View file
Open in desktop
Copy link
Copy Markdown
Member

@JialinHuang803 JialinHuang803 Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot Don't change the generated code manually! You should run npm run smoke-test under packages/typespec-test to update the smoke tests.

Copy link
Copy Markdown
Contributor Author

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already fixed in 107b86c - reverted all manual changes and regenerated using npm run smoke-test in packages/typespec-test. The blob/index.ts is now properly generated by the emitter.

Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

export { BlobClient } from "./blobClient.js";
export { BlobContext, BlobClientOptionalParams, DownloadOptionalParams as BlobClientDownloadOptionalParams } from "./api/index.js";
1 change: 1 addition & 0 deletions packages/typespec-test/test/nestedClient/tspconfig.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ options:
"@azure-tools/typespec-ts":
generate-metadata: true
azure-sdk-for-js: false
hierarchy-client: false
Copy link
Copy Markdown
Member

@JialinHuang803 JialinHuang803 Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot Don't change this file!

Copy link
Copy Markdown
Contributor Author

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already fixed in 107b86c - the tspconfig.yaml has been reverted to its original state (no hierarchy-client line).

emitter-output-dir: "{project-root}/generated/typespec-ts"
package-details:
name: "@msinternal/nestedclient"
10 changes: 8 additions & 2 deletions packages/typespec-ts/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,11 @@ import { emitLoggerFile } from "./modular/emitLoggerFile.js";
import { emitTypes } from "./modular/emitModels.js";
import { existsSync } from "fs";
import { getModuleExports } from "./modular/buildProjectFiles.js";
import { getClientHierarchyMap, getRLCClients } from "./utils/clientUtils.js";
import {
getClientHierarchyMap,
getRLCClients,
getModularClientOptions
} from "./utils/clientUtils.js";
import { join } from "path";
import { loadStaticHelpers } from "./framework/load-static-helpers.js";
import { packageUsesXmlSerialization } from "./modular/serialization/buildXmlSerializerFunction.js";
Expand Down Expand Up @@ -353,7 +357,9 @@ export async function $onEmit(context: EmitContext) {
exportIndex: true,
interfaceOnly: true
});
if (isMultiClients) {
const { subfolder } = getModularClientOptions(subClient);
// Generate index file for multi-client scenarios or nested clients (non-empty subfolder)
if (isMultiClients || subfolder) {
Copy link
Copy Markdown
Member

@JialinHuang803 JialinHuang803 Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot For multi-client scenarios, is it possible for subfolder to be an empty string? If not, can this conditional be simplified to just if(subfolder)?

Copy link
Copy Markdown
Contributor Author

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you're correct! In multi-client scenarios, the subfolder will always be non-empty since each top-level client gets its own subfolder. Simplified the condition to just if (subfolder) and removed the unused isMultiClients variable in 107b86c.

buildSubClientIndexFile(dpgContext, subClient, modularEmitterOptions);
}
buildRootIndex(
Expand Down
Loading
⚡