@azure-tools/typespec-ts 0.33.0 → 0.34.0

package/src/modular/buildClassicalClient.ts

@@ -1,9 +1,3 @@
-import {
-  getImportSpecifier,
-  Imports as RuntimeImports,
-  NameType,
-  normalizeName
-} from "@azure-tools/rlc-common";
 import {
   ClassDeclaration,
   MethodDeclarationStructure,
@@ -11,34 +5,44 @@ import {
   SourceFile,
   StructureKind
 } from "ts-morph";
-import { isRLCMultiEndpoint } from "../utils/clientUtils.js";
-import { SdkContext } from "../utils/interfaces.js";
+import { Client, ModularCodeModel } from "./modularCodeModel.js";
+import { NameType, normalizeName } from "@azure-tools/rlc-common";
 import {
   buildUserAgentOptions,
-  getClientParameters,
-  importCredential
+  getClientParametersDeclaration
 } from "./helpers/clientHelpers.js";
-import { getDocsFromDescription } from "./helpers/docsHelpers.js";
 import {
+  getClassicalClientName,
   getClassicalLayerPrefix,
   getClientName
 } from "./helpers/namingHelpers.js";
+
+import { SdkContext } from "../utils/interfaces.js";
+import { getDocsFromDescription } from "./helpers/docsHelpers.js";
 import { getOperationFunction } from "./helpers/operationHelpers.js";
-import { Client, ModularCodeModel } from "./modularCodeModel.js";
+import { isRLCMultiEndpoint } from "../utils/clientUtils.js";
+import { resolveReference } from "../framework/reference.js";
 import { shouldPromoteSubscriptionId } from "./helpers/classicalOperationHelpers.js";
+import { useDependencies } from "../framework/hooks/useDependencies.js";
 
 export function buildClassicalClient(
-  client: Client,
+  _client: Client,
   dpgContext: SdkContext,
   codeModel: ModularCodeModel
 ) {
-  const { description } = client;
+  const { description, tcgcClient: client } = _client;
+  const dependencies = useDependencies();
   const modularClientName = getClientName(client);
-  const classicalClientName = `${getClientName(client)}Client`;
-  const classicalParams = getClientParameters(client, dpgContext, true);
-  const contextParams = getClientParameters(client, dpgContext, false);
+  const classicalClientName = `${getClassicalClientName(client)}`;
+  const classicalParams = getClientParametersDeclaration(_client, dpgContext, {
+    requiredOnly: true
+  });
+  const contextParams = getClientParametersDeclaration(_client, dpgContext, {
+    onClientOnly: true,
+    requiredOnly: true
+  });
   const srcPath = codeModel.modularOptions.sourceRoot;
-  const subfolder = client.subfolder ?? "";
+  const subfolder = _client.subfolder ?? "";
 
   const clientFile = codeModel.project.createSourceFile(
     `${srcPath}/${subfolder !== "" ? subfolder + "/" : ""}${normalizeName(
@@ -64,21 +68,20 @@ export function buildClassicalClient(
   if (isRLCMultiEndpoint(dpgContext)) {
     clientClass.addProperty({
       name: "_client",
-      type: `Client.${client.rlcClientName}`,
+      type: `Client.${_client.rlcClientName}`,
       scope: Scope.Private
     });
   } else {
     clientClass.addProperty({
       name: "_client",
-      type: `${client.rlcClientName}`,
+      type: `${_client.rlcClientName}`,
       scope: Scope.Private
     });
   }
-
   // Add the pipeline member. This will be the pipeline from /api
   clientClass.addProperty({
     name: "pipeline",
-    type: "Pipeline",
+    type: resolveReference(dependencies.Pipeline),
     scope: Scope.Public,
     isReadonly: true,
     docs: ["The pipeline used by this client to make requests"]
@@ -96,6 +99,7 @@ export function buildClassicalClient(
       if (x === "options") {
         return `{...options, userAgentOptions: ${buildUserAgentOptions(
           constructor,
+          codeModel,
           "azsdk-js-client"
         )}}`;
       } else {
@@ -107,11 +111,10 @@ export function buildClassicalClient(
     `this._client = create${modularClientName}(${paramNames.join(",")})`
   ]);
   constructor.addStatements(`this.pipeline = this._client.pipeline`);
-  importCredential(codeModel.runtimeImports, clientFile);
-  importPipeline(codeModel.runtimeImports, clientFile);
-  importAllModels(clientFile, srcPath, subfolder);
-  buildClientOperationGroups(clientFile, client, dpgContext, clientClass);
+
+  buildClientOperationGroups(clientFile, _client, dpgContext, clientClass);
   importAllApis(clientFile, srcPath, subfolder);
+  clientFile.fixUnusedIdentifiers();
   return clientFile;
 }
 
@@ -137,76 +140,6 @@ function importAllApis(
   });
 }
 
-function importAllModels(
-  clientFile: SourceFile,
-  srcPath: string,
-  subfolder: string
-) {
-  const project = clientFile.getProject();
-  const apiModels = project.getSourceFile(
-    `${srcPath}/${subfolder !== "" ? subfolder + "/" : ""}models/models.ts`
-  );
-
-  if (!apiModels) {
-    return;
-  }
-
-  const exported = [...apiModels.getExportedDeclarations().keys()].filter(
-    (e) => {
-      return !e.startsWith("_");
-    }
-  );
-
-  if (exported.length > 0) {
-    clientFile.addImportDeclaration({
-      moduleSpecifier: `./models/models.js`,
-      namedImports: exported
-    });
-  }
-
-  const apiModelsOptions = project.getSourceFile(
-    `${srcPath}/${subfolder !== "" ? subfolder + "/" : ""}models/options.ts`
-  );
-
-  if (!apiModelsOptions) {
-    return;
-  }
-
-  const exportedOptions = [
-    ...apiModelsOptions.getExportedDeclarations().keys()
-  ];
-
-  clientFile.addImportDeclaration({
-    moduleSpecifier: `./models/options.js`,
-    namedImports: exportedOptions
-  });
-
-  const pagingTypes = project.getSourceFile(
-    `${srcPath}/${subfolder !== "" ? subfolder + "/" : ""}models/pagingTypes.ts`
-  );
-
-  if (!pagingTypes) {
-    return;
-  }
-
-  const exportedPaingTypes = [...pagingTypes.getExportedDeclarations().keys()];
-
-  clientFile.addImportDeclaration({
-    moduleSpecifier: `./models/pagingTypes.js`,
-    namedImports: exportedPaingTypes
-  });
-}
-
-function importPipeline(
-  runtimeImports: RuntimeImports,
-  clientSourceFile: SourceFile
-): void {
-  clientSourceFile.addImportDeclaration({
-    moduleSpecifier: getImportSpecifier("restPipeline", runtimeImports),
-    namedImports: ["Pipeline"]
-  });
-}
-
 function buildClientOperationGroups(
   clientFile: SourceFile,
   client: Client,
@@ -231,7 +164,7 @@ function buildClientOperationGroups(
     );
     if (groupName === "") {
       operationGroup.operations.forEach((op) => {
-        const declarations = getOperationFunction(op, clientType);
+        const declarations = getOperationFunction(dpgContext, op, clientType);
         const method: MethodDeclarationStructure = {
           docs: declarations.docs,
           name: declarations.propertyName ?? declarations.name ?? "FIXME",

package/src/modular/buildClassicalOperationGroups.ts

@@ -1,6 +1,5 @@
 import { NameType } from "@azure-tools/rlc-common";
 import { SourceFile } from "ts-morph";
-import { importModels } from "./buildOperations.js";
 import { getClassicalOperation } from "./helpers/classicalOperationHelpers.js";
 import { getClassicalLayerPrefix } from "./helpers/namingHelpers.js";
 import {
@@ -44,15 +43,6 @@ export function buildClassicOperationFiles(
         );
       getClassicalOperation(dpgContext, client, classicFile, operationGroup);
 
-      // Import models used from ./models.ts
-      // We SHOULD keep this because otherwise ts-morph will "helpfully" try to import models from the rest layer when we call fixMissingImports().
-      importModels(
-        srcPath,
-        classicFile,
-        codeModel.project,
-        subfolder,
-        operationGroup.namespaceHierarchies.length
-      );
       importApis(classicFile, client, codeModel, operationGroup);
       // We need to import the paging helpers and types explicitly because ts-morph may not be able to find them.
       classicOperationFiles.set(classicOperationFileName, classicFile);
@@ -93,10 +83,6 @@ export function buildClassicOperationFiles(
           operationGroup,
           layer
         );
-
-        // Import models used from ./models.ts
-        // We SHOULD keep this because otherwise ts-morph will "helpfully" try to import models from the rest layer when we call fixMissingImports().
-        importModels(srcPath, classicFile, codeModel.project, subfolder, layer);
         importApis(classicFile, client, codeModel, operationGroup, layer);
         classicOperationFiles.set(classicOperationFileName, classicFile);
       }

package/src/modular/buildClientContext.ts

@@ -1,71 +1,90 @@
+import { Client, ModularCodeModel } from "./modularCodeModel.js";
 import {
-  getImportSpecifier,
-  isAzurePackage,
   NameType,
+  isAzurePackage,
   normalizeName
 } from "@azure-tools/rlc-common";
-import { SourceFile } from "ts-morph";
-import { SdkContext } from "../utils/interfaces.js";
-import { importModels } from "./buildOperations.js";
 import {
   buildGetClientCredentialParam,
   buildGetClientEndpointParam,
   buildGetClientOptionsParam,
+  getClientParameterName,
   getClientParameters,
-  importCredential
+  getClientParametersDeclaration
 } from "./helpers/clientHelpers.js";
-import { getDocsFromDescription } from "./helpers/docsHelpers.js";
+
+import { SdkContext } from "../utils/interfaces.js";
+import { SourceFile } from "ts-morph";
 import { getClientName } from "./helpers/namingHelpers.js";
-import { getType } from "./helpers/typeHelpers.js";
-import { Client, ModularCodeModel } from "./modularCodeModel.js";
+import { getDocsFromDescription } from "./helpers/docsHelpers.js";
+import { getTypeExpression } from "./type-expressions/get-type-expression.js";
+import { resolveReference } from "../framework/reference.js";
+import { useDependencies } from "../framework/hooks/useDependencies.js";
+import { buildEnumTypes, getApiVersionEnum } from "./emitModels.js";
+import {
+  SdkHttpParameter,
+  SdkParameter
+} from "@azure-tools/typespec-client-generator-core";
+
+/**
+ * This function gets the path of the file containing the modular client context
+ */
+export function getClientContextPath(
+  _client: Client,
+  codeModel: ModularCodeModel
+): string {
+  const { subfolder, tcgcClient: client } = _client;
+  const name = getClientName(client);
+  const srcPath = codeModel.modularOptions.sourceRoot;
+  const contentPath = `${srcPath}/${
+    subfolder && subfolder !== "" ? subfolder + "/" : ""
+  }api/${normalizeName(name, NameType.File)}Context.ts`;
+  return contentPath;
+}
 
 /**
  * This function creates the file containing the modular client context
  */
 export function buildClientContext(
-  client: Client,
+  _client: Client,
   dpgContext: SdkContext,
   codeModel: ModularCodeModel
 ): SourceFile {
-  const { description, subfolder } = client;
+  const { description, tcgcClient: client } = _client;
+  const dependencies = useDependencies();
   const name = getClientName(client);
-  const params = getClientParameters(client, dpgContext);
-  const srcPath = codeModel.modularOptions.sourceRoot;
+  const requiredParams = getClientParametersDeclaration(_client, dpgContext, {
+    onClientOnly: false,
+    requiredOnly: true
+  });
   const clientContextFile = codeModel.project.createSourceFile(
-    `${srcPath}/${
-      subfolder && subfolder !== "" ? subfolder + "/" : ""
-    }/api/${normalizeName(name, NameType.File)}Context.ts`
+    getClientContextPath(_client, codeModel)
   );
 
-  importCredential(codeModel.runtimeImports, clientContextFile);
-  importModels(srcPath, clientContextFile, codeModel.project, subfolder);
-  clientContextFile.addImportDeclaration({
-    moduleSpecifier: getImportSpecifier("restClient", codeModel.runtimeImports),
-    namedImports: ["ClientOptions", "Client", "getClient"]
-  });
-
   clientContextFile.addInterface({
     isExported: true,
-    name: `${client.rlcClientName}`,
-    extends: ["Client"]
+    name: `${_client.rlcClientName}`,
+    extends: [resolveReference(dependencies.Client)],
+    docs: getDocsFromDescription(description)
   });
 
   clientContextFile.addInterface({
     name: `${name}ClientOptionalParams`,
     isExported: true,
-    extends: ["ClientOptions"],
-    properties: client.parameters
-      .filter((p) => {
-        return (
-          p.optional || (p.type.type !== "constant" && p.clientDefaultValue)
-        );
-      })
+    extends: [resolveReference(dependencies.ClientOptions)],
+    properties: getClientParameters(_client, dpgContext, {
+      optionalOnly: true
+    })
+      .filter((p) => p.name !== "endpoint")
       .map((p) => {
         return {
-          name: p.clientName,
-          type: getType(p.type).name,
+          name: normalizeName(p.name, NameType.Parameter),
+          type:
+            p.name.toLowerCase() === "apiversion"
+              ? "string"
+              : getTypeExpression(dpgContext, p.type),
           hasQuestionToken: true,
-          docs: getDocsFromDescription(p.description)
+          docs: getDocsWithKnownVersion(dpgContext, p)
         };
       }),
     docs: ["Optional parameters for the client."]
@@ -84,13 +103,17 @@ export function buildClientContext(
   const factoryFunction = clientContextFile.addFunction({
     docs: getDocsFromDescription(description),
     name: `create${name}`,
-    returnType: `${client.rlcClientName}`,
-    parameters: params,
+    returnType: `${_client.rlcClientName}`,
+    parameters: requiredParams,
     isExported: true
   });
 
-  const endpointParam = buildGetClientEndpointParam(factoryFunction, client);
-  const credentialParam = buildGetClientCredentialParam(client, codeModel);
+  const endpointParam = buildGetClientEndpointParam(
+    factoryFunction,
+    dpgContext,
+    _client
+  );
+  const credentialParam = buildGetClientCredentialParam(_client, codeModel);
   const optionsParam = buildGetClientOptionsParam(
     factoryFunction,
     codeModel,
@@ -98,20 +121,17 @@ export function buildClientContext(
   );
 
   factoryFunction.addStatements(
-    `const clientContext = getClient(${endpointParam}, ${credentialParam}, ${optionsParam});`
+    `const clientContext = ${resolveReference(
+      dependencies.getClient
+    )}(${endpointParam}, ${credentialParam}, ${optionsParam});`
   );
 
   const { customHttpAuthHeaderName, customHttpAuthSharedKeyPrefix } =
     codeModel.options;
 
   if (customHttpAuthHeaderName && customHttpAuthSharedKeyPrefix) {
-    clientContextFile.addImportDeclaration({
-      moduleSpecifier: getImportSpecifier("coreAuth", codeModel.runtimeImports),
-      namedImports: ["isKeyCredential"]
-    });
-
     factoryFunction.addStatements(`
-      if(isKeyCredential(credential)) {
+      if(${resolveReference(dependencies.isKeyCredential)}(credential)) {
         clientContext.pipeline.addPolicy({ 
           name: "customKeyCredentialPolicy",
           sendRequest(request, next) {
@@ -126,11 +146,13 @@ export function buildClientContext(
   let apiVersionPolicyStatement = `clientContext.pipeline.removePolicy({ name: "ApiVersionPolicy" });`;
 
   if (dpgContext.hasApiVersionInClient) {
-    const apiVersionParam = client.parameters.find((x) => x.isApiVersion);
+    const apiVersionParam = getClientParameters(_client, dpgContext).find(
+      (x) => x.isApiVersionParam && x.kind === "method"
+    );
 
-    if (apiVersionParam?.location === "query") {
+    if (apiVersionParam) {
       if (apiVersionParam.clientDefaultValue) {
-        apiVersionPolicyStatement += `const ${apiVersionParam.clientName} = options.${apiVersionParam.clientName} ?? "${apiVersionParam.clientDefaultValue}";`;
+        apiVersionPolicyStatement += `const apiVersion = options.apiVersion ?? "${apiVersionParam.clientDefaultValue}";`;
       }
 
       apiVersionPolicyStatement += `
@@ -143,7 +165,7 @@ export function buildClientContext(
           if (!url.searchParams.get("api-version")) {
             req.url = \`\${req.url}\${
               Array.from(url.searchParams.keys()).length > 0 ? "&" : "?"
-            }api-version=\${${apiVersionParam.clientName}}\`;
+            }api-version=\${${getClientParameterName(apiVersionParam)}}\`;
           }
     
           return next(req);
@@ -173,3 +195,21 @@ export function buildClientContext(
   clientContextFile.fixUnusedIdentifiers();
   return clientContextFile;
 }
+
+function getDocsWithKnownVersion(
+  dpgContext: SdkContext,
+  param: SdkParameter | SdkHttpParameter
+) {
+  const docs = getDocsFromDescription(param.doc);
+  if (param.name.toLowerCase() !== "apiversion") {
+    return docs;
+  }
+  const apiVersionEnum = getApiVersionEnum(dpgContext);
+  if (apiVersionEnum) {
+    const [_, knownValuesEnum] = buildEnumTypes(dpgContext, apiVersionEnum);
+    docs.push(
+      `Known values of {@link ${knownValuesEnum.name}} that the service accepts.`
+    );
+  }
+  return docs;
+}