@azure-tools/typespec-ts 0.30.1 → 0.31.0-alpha.20240723.1

package/src/framework/sample.ts

@@ -0,0 +1,92 @@
+import {
+  Project,
+  StructureKind,
+  InterfaceDeclarationStructure,
+  FunctionDeclarationStructure
+} from "ts-morph";
+import { useBinder } from "./hooks/binder.js";
+import { addDeclaration } from "./declaration.js";
+import { resolveReference } from "./reference.js";
+
+// Create a new ts-morph project
+const project = new Project();
+
+// Create a source file
+const sourceFile = project.createSourceFile("test.ts", "", { overwrite: true });
+
+// Initialize the binder
+const binder = useBinder();
+
+// Define an interface model. In practice this would be a type object (e.g. from TypeSpec, TCGC, modelerfour, etc.)
+// At this framework level, we're just using a simple object, there is no coupling with the actual type system, but this is flexible so any object can be used.
+const modelType = {
+  name: "MyInterface",
+  properties: [{ name: "id", type: "number" }]
+};
+
+// Define a function model
+const functionType = {
+  name: "MyFunction",
+  returnType: "void",
+  body: `console.log("Hello World");`
+};
+
+// Create an interface declaration structure. This illustrates a similar pattern to the one used in the emitter. Transorming a model into a structure for ts-morph.
+const interfaceDeclaration: InterfaceDeclarationStructure = {
+  kind: StructureKind.Interface,
+  name: modelType.name,
+  properties: modelType.properties.map((p) => ({
+    name: p.name,
+    type: p.type
+  }))
+};
+
+// Create a function declaration structure
+const functionDeclaration: FunctionDeclarationStructure = {
+  kind: StructureKind.Function,
+  name: functionType.name,
+  returnType: functionType.returnType,
+  statements: functionType.body
+};
+
+// Helper functions to add the declarations to the source file. These are needed to be able to leverage the binder to track the declarations.
+// We'll be moving from sourceFile.addInterface(interfaceDeclaration) to addDeclaration(sourceFile, interfaceDeclaration, interfaceModel)
+addDeclaration(sourceFile, interfaceDeclaration, modelType);
+addDeclaration(sourceFile, functionDeclaration, functionType);
+
+// Create another source file
+const sourceFile2 = project.createSourceFile("test2.ts", "", {
+  overwrite: true
+});
+
+// Add statements referencing the tracked declarations
+const functionReference = resolveReference(functionType);
+const modelReference = resolveReference(modelType);
+
+sourceFile2.addStatements(`${functionReference}();`);
+sourceFile2.addStatements(`let obj: ${modelReference} = { id: 1 };`);
+
+// Apply imports to ensure correct references
+binder.applyImports();
+
+// Output the generated files
+console.log("// test.ts");
+console.log(sourceFile.getFullText());
+console.log("// test2.ts");
+console.log(sourceFile2.getFullText());
+
+// Output
+// test.ts
+// interface MyInterface {
+//     id: number;
+// }
+
+// function MyFunction(): void {
+//     console.log("Hello World");
+// }
+
+// // test2.ts
+// import { MyFunction, MyInterface } from "./test";
+
+// MyFunction();
+// let obj: MyInterface = { id: 1 };

package/src/index.ts

@@ -8,7 +8,6 @@ import {
   buildEsLintConfig,
   buildIndexFile,
   buildIsUnexpectedHelper,
-  buildKarmaConfigFile,
   buildLogger,
   buildPackageFile,
   buildPaginateHelper as buildRLCPaginateHelper,
@@ -28,7 +27,8 @@ import {
   getClientName,
   hasUnexpectedHelper,
   RLCModel,
-  RLCOptions
+  RLCOptions,
+  buildLicenseFile
 } from "@azure-tools/rlc-common";
 import { createSdkContext } from "@azure-tools/typespec-client-generator-core";
 import { EmitContext, Program } from "@typespec/compiler";
@@ -60,7 +60,6 @@ import { buildSerializeUtils } from "./modular/buildSerializeUtils.js";
 import { buildSubpathIndexFile } from "./modular/buildSubpathIndex.js";
 import { buildModels, buildModelsOptions } from "./modular/emitModels.js";
 import { ModularCodeModel } from "./modular/modularCodeModel.js";
-import { buildSerializers } from "./modular/serialization/index.js";
 import { transformRLCModel } from "./transform/transform.js";
 import { transformRLCOptions } from "./transform/transfromRLCOptions.js";
 import { getRLCClients } from "./utils/clientUtils.js";
@@ -68,6 +67,7 @@ import { emitContentByBuilder, emitModels } from "./utils/emitUtil.js";
 import { GenerationDirDetail, SdkContext } from "./utils/interfaces.js";
 import { provideContext, useContext } from "./contextManager.js";
 import { emitSerializerHelpersFile } from "./modular/buildHelperSerializers.js";
+import { provideSdkTypes } from "./framework/hooks/sdkTypes.js";
 
 export * from "./lib.js";
 
@@ -89,6 +89,7 @@ export async function $onEmit(context: EmitContext) {
     compilerContext: context,
     tcgcContext: dpgContext
   });
+  provideSdkTypes(dpgContext.sdkPackage);
 
   const rlcCodeModels: RLCModel[] = [];
   let modularCodeModel: ModularCodeModel;
@@ -220,15 +221,11 @@ export async function $onEmit(context: EmitContext) {
           isMultiClients
         );
         // build operation files
-        const serializerMap = env["EXPERIMENTAL_TYPESPEC_TS_SERIALIZATION"]
-          ? buildSerializers(dpgContext, modularCodeModel, subClient)
-          : undefined;
         buildOperationFiles(
           subClient,
           dpgContext,
           modularCodeModel,
-          hasClientUnexpectedHelper,
-          serializerMap
+          hasClientUnexpectedHelper
         );
         buildClientContext(subClient, dpgContext, modularCodeModel);
         buildSubpathIndexFile(subClient, modularCodeModel, "models");
@@ -289,7 +286,8 @@ export async function $onEmit(context: EmitContext) {
       const commonBuilders = [
         buildRollupConfig,
         buildApiExtractorConfig,
-        buildReadmeFile
+        buildReadmeFile,
+        buildLicenseFile
       ];
       if (option.moduleKind === "esm") {
         commonBuilders.push((model) => buildVitestConfig(model, "node"));
@@ -329,7 +327,7 @@ export async function $onEmit(context: EmitContext) {
     if (option.generateTest && isAzureFlavor) {
       await emitContentByBuilder(
         program,
-        [buildKarmaConfigFile, buildRecordedClientFile, buildSampleTest],
+        [buildRecordedClientFile, buildSampleTest],
         rlcClient,
         dpgContext.generationPathDetail?.metadataDir
       );

package/src/lib.ts

@@ -231,6 +231,12 @@ const libDef = {
       messages: {
         default: paramMessage`Please note that only compatible additional properties is supported for now. You can enable compatibilityMode to generate compatible additional properties for the model - ${"modelName"}.`
       }
+    },
+    "default-response-body-type": {
+      severity: "warning",
+      messages: {
+        default: paramMessage`Please note the body type of default response for operation - ${"operationName"} is not a model type.`
+      }
     }
   },
   emitter: {

package/src/modular/buildClassicalClient.ts

@@ -16,6 +16,7 @@ import { SdkContext } from "../utils/interfaces.js";
 import { importLroCoreDependencies } from "./buildLroFiles.js";
 import {
   getClientParameters,
+  getUserAgentStatements,
   importCredential
 } from "./helpers/clientHelpers.js";
 import { getDocsFromDescription } from "./helpers/docsHelpers.js";
@@ -48,7 +49,7 @@ export function buildClassicalClient(
   );
 
   clientFile.addExportDeclaration({
-    namedExports: [`${classicalClientName}Options`],
+    namedExports: [`${classicalClientName}OptionalParams`],
     moduleSpecifier: `./api/${normalizeName(
       modularClientName,
       NameType.File
@@ -89,10 +90,16 @@ export function buildClassicalClient(
     docs: getDocsFromDescription(description),
     parameters: classicalParams
   });
+
+  const paramNames = (contextParams ?? []).map((p) => p.name);
+  const { updatedParamNames, userAgentStatements } = getUserAgentStatements(
+    "azsdk-js-client",
+    paramNames
+  );
+
   constructor.addStatements([
-    `this._client = create${modularClientName}(${(contextParams ?? [])
-      .map((p) => p.name)
-      .join(",")})`
+    userAgentStatements,
+    `this._client = create${modularClientName}(${updatedParamNames.join(",")})`
   ]);
   constructor.addStatements(`this.pipeline = this._client.pipeline`);
   importLroCoreDependencies(clientFile);

package/src/modular/buildClientContext.ts

@@ -8,6 +8,7 @@ import { isRLCMultiEndpoint } from "../utils/clientUtils.js";
 import { SdkContext } from "../utils/interfaces.js";
 import { importModels } from "./buildOperations.js";
 import {
+  getUserAgentStatements,
   getClientParameters,
   importCredential
 } from "./helpers/clientHelpers.js";
@@ -43,7 +44,7 @@ export function buildClientContext(
   });
 
   clientContextFile.addInterface({
-    name: `${name}ClientOptions`,
+    name: `${name}ClientOptionalParams`,
     isExported: true,
     extends: ["ClientOptions"],
     properties: client.parameters
@@ -105,11 +106,16 @@ export function buildClientContext(
   }
 
   const paramNames = params.map((p) => p.name);
-  const getClientStatement = `const clientContext = getClient(${paramNames.join(
-    ","
-  )})`;
+  const { userAgentStatements, updatedParamNames } = getUserAgentStatements(
+    "azsdk-js-api",
+    paramNames
+  );
 
-  factoryFunction.addStatements([getClientStatement, "return clientContext;"]);
+  factoryFunction.addStatements([
+    userAgentStatements,
+    `const clientContext = getClient(${updatedParamNames});`,
+    `return clientContext;`
+  ]);
 
   if (isRLCMultiEndpoint(dpgContext)) {
     clientContextFile.addImportDeclarations([

package/src/modular/buildCodeModel.ts

@@ -14,6 +14,7 @@ import {
   getClientNamespaceString,
   getClientType,
   getDefaultApiVersion,
+  getHttpOperationWithCache,
   getLibraryName,
   getSdkBuiltInType,
   getSdkUnion,
@@ -43,7 +44,6 @@ import {
   getPropertyType,
   getSummary,
   getVisibility,
-  ignoreDiagnostics,
   IntrinsicScalarName,
   IntrinsicType,
   isErrorModel,
@@ -67,7 +67,6 @@ import {
 } from "@typespec/compiler";
 import {
   getAuthentication,
-  getHttpOperation,
   getServers,
   HttpAuth,
   HttpOperation,
@@ -471,14 +470,10 @@ function emitBodyParameter(
     if (contentTypes.length === 0) {
       contentTypes = ["application/json"];
     }
-    const type = getType(
-      context,
-      getBodyType(context.program, httpOperation)!,
-      {
-        disableEffectiveModel: true,
-        usage: UsageFlags.Input
-      }
-    );
+    const type = getType(context, getBodyType(httpOperation)!, {
+      disableEffectiveModel: true,
+      usage: UsageFlags.Input
+    });
 
     return {
       contentTypes,
@@ -677,7 +672,7 @@ function emitOperation(
   }
   const lro = isLongRunningOperation(
     context.program,
-    ignoreDiagnostics(getHttpOperation(context.program, operation))
+    getHttpOperationWithCache(context, operation)
   );
   const pagingMetadata = getPagedResult(context.program, operation);
   // Disable the paging feature if no itemsSegments is found.
@@ -761,9 +756,7 @@ function emitBasicOperation(
       parameters.push(param);
     }
   }
-  const httpOperation = ignoreDiagnostics(
-    getHttpOperation(context.program, operation)
-  );
+  const httpOperation = getHttpOperationWithCache(context, operation);
   const sourceOperation =
     operation.sourceOperation &&
     !isTemplateDeclarationOrInstance(operation.sourceOperation)
@@ -774,9 +767,7 @@ function emitBasicOperation(
     sourceOperation
   );
   const sourceOperationName = getOperationName(context, sourceOperation);
-  const sourceRoutePath = ignoreDiagnostics(
-    getHttpOperation(context.program, operation)
-  ).path;
+  const sourceRoutePath = getHttpOperationWithCache(context, operation).path;
   const rlcResponses = rlcModels.responses?.filter((op) => {
     return (
       (sourceOperationGroupName === "" ||
@@ -841,10 +832,20 @@ function emitBasicOperation(
   } else {
     bodyParameter = emitBodyParameter(context, httpOperation);
     // Flatten the body parameter if it is an anonymous model
+    const originalBodyType = httpOperation.parameters.body.type;
+
     if (
       bodyParameter.type.type === "model" &&
-      bodyParameter.type.name === "" &&
-      bodyParameter.type.properties.length > 0
+      originalBodyType.kind === "Model" &&
+      originalBodyType.name === "" &&
+      [...originalBodyType.properties.keys()].every(
+        (k) =>
+          operation.parameters.properties.has(k) &&
+          (operation.parameters.properties.get(k) ===
+            (originalBodyType as Model).properties.get(k) ||
+            operation.parameters.properties.get(k) ===
+              (originalBodyType as Model).properties.get(k)?.sourceProperty)
+      )
     ) {
       for (const param of bodyParameter.type.properties) {
         param.implementation = "Method";
@@ -1358,7 +1359,7 @@ function emitUnion(
   usage: UsageFlags
 ): Record<string, any> {
   let sdkType = getSdkUnion(context, type);
-  const isNull = false;
+  const isNull = sdkType.kind === "nullable";
   if (sdkType.kind === "nullable") {
     sdkType = sdkType.type;
   }
@@ -1714,7 +1715,10 @@ function emitCredentialParam(
         credential_types.push(type);
       }
     }
-    if (credential_types.length > 0) {
+    if (
+      credential_types.length > 0 &&
+      context.rlcOptions?.addCredentials !== false
+    ) {
       let type: EmitterType;
       if (credential_types.length === 1 && credential_types[0]) {
         type = credential_types[0];

package/src/modular/buildOperations.ts

@@ -5,7 +5,6 @@ import {
   NameType,
   normalizeName
 } from "@azure-tools/rlc-common";
-import { env } from "process";
 import { Project, SourceFile } from "ts-morph";
 import { isRLCMultiEndpoint } from "../utils/clientUtils.js";
 import { SdkContext } from "../utils/interfaces.js";
@@ -22,11 +21,6 @@ import {
 import { buildType } from "./helpers/typeHelpers.js";
 import { OperationPathAndDeserDetails } from "./interfaces.js";
 import { Client, ModularCodeModel, Operation } from "./modularCodeModel.js";
-import {
-  getDeserializePrivateFunction as experimentalGetDeserializePrivateFunction,
-  getSendPrivateFunction as experimentalGetSendPrivateFunction
-} from "./serialization/operationHelpers.js";
-import { SerializerMap } from "./serialization/util.js";
 import { addImportBySymbol } from "../utils/importHelper.js";
 /**
  * This function creates a file under /api for each operation group.
@@ -37,8 +31,7 @@ export function buildOperationFiles(
   client: Client,
   dpgContext: SdkContext,
   codeModel: ModularCodeModel,
-  needUnexpectedHelper: boolean = true,
-  serializerMap?: SerializerMap
+  needUnexpectedHelper: boolean = true
 ) {
   const operationFiles = [];
   const isMultiEndpoint = isRLCMultiEndpoint(dpgContext);
@@ -143,39 +136,18 @@ export function buildOperationFiles(
     }
     operationGroup.operations.forEach((o) => {
       const operationDeclaration = getOperationFunction(o, clientType);
-      const sendOperationDeclaration = env[
-        "EXPERIMENTAL_TYPESPEC_TS_SERIALIZATION"
-      ]
-        ? experimentalGetSendPrivateFunction(
-            dpgContext,
-            o,
-            clientType,
-            serializerMap,
-            codeModel.runtimeImports
-          )
-        : getSendPrivateFunction(
-            dpgContext,
-            o,
-            clientType,
-            codeModel.runtimeImports
-          );
-      const deserializeOperationDeclaration = env[
-        "EXPERIMENTAL_TYPESPEC_TS_SERIALIZATION"
-      ]
-        ? experimentalGetDeserializePrivateFunction(
-            dpgContext,
-            o,
-            isMultiEndpoint,
-            needUnexpectedHelper,
-            codeModel.runtimeImports,
-            serializerMap
-          )
-        : getDeserializePrivateFunction(
-            o,
-            isMultiEndpoint,
-            needUnexpectedHelper,
-            codeModel.runtimeImports
-          );
+      const sendOperationDeclaration = getSendPrivateFunction(
+        dpgContext,
+        o,
+        clientType,
+        codeModel.runtimeImports
+      );
+      const deserializeOperationDeclaration = getDeserializePrivateFunction(
+        o,
+        isMultiEndpoint,
+        needUnexpectedHelper,
+        codeModel.runtimeImports
+      );
       operationGroupFile.addFunctions([
         sendOperationDeclaration,
         deserializeOperationDeclaration,

package/src/modular/buildRootIndex.ts

@@ -99,7 +99,7 @@ function exportClassicalClient(
 ) {
   const clientName = `${getClientName(client)}Client`;
   indexFile.addExportDeclaration({
-    namedExports: [clientName, `${clientName}Options`],
+    namedExports: [clientName, `${clientName}OptionalParams`],
     moduleSpecifier: `./${
       subfolder !== "" && !isSubClient ? subfolder + "/" : ""
     }${normalizeName(clientName, NameType.File)}.js`

package/src/modular/buildSerializeUtils.ts

@@ -198,7 +198,8 @@ export function isSpecialUnionVariant(
         })
         ?.some((p) => {
           return isSpecialUnionVariant(p, [...variantStack, p]);
-        }))
+        })) ||
+    (t.type === "enum" && !(t.isFixed || t.isNonExhaustive))
   ) {
     specialVariantMap.set(t, true);
     variantStack.pop();

package/src/modular/helpers/clientHelpers.ts

@@ -21,7 +21,7 @@ export function getClientParameters(
   const name = getClientName(client);
   const optionsParam = {
     name: "options",
-    type: `${name}ClientOptions`,
+    type: `${name}ClientOptionalParams`,
     initializer: "{}"
   };
 
@@ -58,6 +58,30 @@ export function getClientParameters(
   return params;
 }
 
+export function getUserAgentStatements(
+  sdkUserAgentPrefix: string,
+  paramNames: string[]
+): { userAgentStatements: string; updatedParamNames: string[] } {
+  const userAgentStatements = `
+    const prefixFromOptions = options?.userAgentOptions?.userAgentPrefix;
+    const userAgentPrefix = ${
+      "prefixFromOptions ? `${prefixFromOptions} " +
+      sdkUserAgentPrefix +
+      "` : " +
+      `"${sdkUserAgentPrefix}"`
+    };
+  `;
+
+  // Update param names to spread over options
+  const updatedParamNames = paramNames.map((x) =>
+    x === "options"
+      ? "{ ...options, userAgentOptions: { userAgentPrefix } }"
+      : x
+  );
+
+  return { userAgentStatements, updatedParamNames };
+}
+
 export function importCredential(
   runtimeImports: RuntimeImports,
   clientSourceFile: SourceFile

package/src/modular/helpers/namingHelpers.ts

@@ -13,7 +13,6 @@ import {
   Operation,
   OperationGroup
 } from "../modularCodeModel.js";
-import { isDefined } from "../serialization/util.js";
 
 export function getClientName(client: Client) {
   return client.name.replace(/Client$/, "");
@@ -77,6 +76,10 @@ export function getClassicalLayerPrefix(
   return prefix.join(separator);
 }
 
+export function isDefined<T>(thing: T | undefined | null): thing is T {
+  return typeof thing !== "undefined" && thing !== null;
+}
+
 export function getRLCIndexFilePath(
   dpgContext: SdkContext,
   client: Client | SdkClient,