@azure-tools/typespec-ts 0.15.0 → 0.16.0

package/src/modular/buildCodeModel.ts

@@ -27,10 +27,8 @@ import {
   isStringType,
   getPropertyType,
   isNumericType,
-  getFormat,
   getMinItems,
   getMaxItems,
-  EmitContext,
   listServices,
   Union,
   Type,
@@ -38,12 +36,12 @@ import {
   getProjectedName,
   isNullType,
   getEncode,
-  isTemplateDeclarationOrInstance
+  isTemplateDeclarationOrInstance,
+  getFormat
 } from "@typespec/compiler";
 import {
   getAuthentication,
   getHeaderFieldName,
-  getHttpOperation,
   getPathParamName,
   getQueryParamName,
   getServers,
@@ -54,7 +52,8 @@ import {
   HttpServer,
   isStatusCode,
   HttpOperation,
-  isHeader
+  isHeader,
+  getHttpOperation
 } from "@typespec/http";
 import { getAddedOnVersions } from "@typespec/versioning";
 import {
@@ -65,7 +64,6 @@ import {
   isApiVersion,
   getDefaultApiVersion,
   getClientNamespaceString,
-  createSdkContext,
   getSdkUnion,
   getAllModels,
   SdkSimpleType,
@@ -82,15 +80,24 @@ import {
   Type as HrlcType,
   Header
 } from "./modularCodeModel.js";
-import { transformRLCOptions } from "../transform/transfromRLCOptions.js";
-import { getEnrichedDefaultApiVersion } from "../utils/modelUtils.js";
+import {
+  getEnrichedDefaultApiVersion,
+  isAzureCoreErrorType
+} from "../utils/modelUtils.js";
 import { camelToSnakeCase, toCamelCase } from "../utils/casingUtils.js";
-import { RLCModel, getClientName } from "@azure-tools/rlc-common";
+import {
+  RLCModel,
+  getClientName,
+  NameType,
+  normalizeName
+} from "@azure-tools/rlc-common";
 import {
   getOperationGroupName,
-  getOperationName
+  getOperationName,
+  isIgnoredHeaderParam
 } from "../utils/operationUtil.js";
 import { SdkContext } from "../utils/interfaces.js";
+import { Project } from "ts-morph";
 
 interface HttpServerParameter {
   type: "endpointPath";
@@ -148,7 +155,8 @@ function isSimpleType(
       getMaxValue,
       getMinLength,
       getMaxLength,
-      getPattern
+      getPattern,
+      getEncode
     ];
     for (const func of funcs) {
       if (func(program, type)) {
@@ -187,7 +195,7 @@ function handleDiscriminator(context: SdkContext, type: Model, model: any) {
         }
       }
     }
-    // it is not included in properties of cadl but needed by python codegen
+    // it is not included in properties of typespec but needed by python codegen
     if (discriminatorProperty) {
       const discriminatorType = { ...discriminatorProperty.type };
       discriminatorType.value = null;
@@ -270,8 +278,7 @@ function getType(
   options: { disableEffectiveModel?: boolean } = {}
 ): any {
   // don't cache simple type(string, int, etc) since decorators may change the result
-  const enableCache =
-    !isSimpleType(context.program, type) && !isEmptyModel(type);
+  const enableCache = !isSimpleType(context.program, type);
   const effectiveModel =
     !options.disableEffectiveModel &&
     (type.kind === "Model" || type.kind === "Union")
@@ -291,6 +298,10 @@ function getType(
     newValue = emitType(context, type);
   }
 
+  if (type.kind === "ModelProperty" || type.kind === "Scalar") {
+    newValue = applyEncoding(context.program, type, newValue);
+  }
+
   if (enableCache) {
     typesMap.set(effectiveModel, newValue);
     if (type.kind === "Union") {
@@ -328,6 +339,7 @@ type ParamBase = {
   addedOn: string | undefined;
   clientName: string;
   inOverload: boolean;
+  format?: string;
 };
 function emitParamBase(
   program: Program,
@@ -337,12 +349,15 @@ function emitParamBase(
   let name: string;
   let description: string = "";
   let addedOn: string | undefined;
+  let format: string | undefined;
 
   if (parameter.kind === "ModelProperty") {
+    const newParameter = applyEncoding(program, parameter, parameter);
     optional = parameter.optional;
     name = parameter.name;
     description = getDocStr(program, parameter);
     addedOn = getAddedOnVersion(program, parameter);
+    format = newParameter.format;
   } else {
     optional = false;
     name = "body";
@@ -353,7 +368,8 @@ function emitParamBase(
     description,
     addedOn,
     clientName: applyCasing(name, { casing: CASING }),
-    inOverload: false
+    inOverload: false,
+    format
   };
 }
 
@@ -421,7 +437,6 @@ function emitBodyParameter(
   const type = getType(context, getBodyType(context.program, httpOperation), {
     disableEffectiveModel: true
   });
-
   if (type.type === "model" && type.name === "") {
     type.name = capitalize(httpOperation.operation.name) + "Request";
   }
@@ -459,9 +474,10 @@ function emitParameter(
   const paramMap: any = {
     restApiName: parameter.name,
     location: parameter.type,
-    type: type,
+    type: base.format ? { ...type, format: base.format } : type,
     implementation: implementation,
-    skipUrlEncoding: parameter.type === "endpointPath"
+    skipUrlEncoding: parameter.type === "endpointPath",
+    format: (parameter as any).format ?? base.format
   };
 
   if (paramMap.type.type === "constant") {
@@ -550,23 +566,6 @@ function emitResponseHeaders(
   return retval;
 }
 
-function isAzureCoreErrorType(t?: Type): boolean {
-  if (
-    t?.kind !== "Model" ||
-    !["Error", "ErrorResponse", "InnerError"].includes(t.name)
-  )
-    return false;
-  const namespaces = ".Azure.Core.Foundations".split(".");
-  while (
-    namespaces.length > 0 &&
-    (t?.kind === "Model" || t?.kind === "Namespace") &&
-    t.namespace?.name === namespaces.pop()
-  ) {
-    t = t.namespace;
-  }
-  return namespaces.length == 0;
-}
-
 function emitResponse(
   context: SdkContext,
   response: HttpOperationResponse,
@@ -749,6 +748,9 @@ function emitBasicOperation(
   });
 
   for (const param of httpOperation.parameters.parameters) {
+    if (isIgnoredHeaderParam(param)) {
+      continue;
+    }
     const emittedParam = emitParameter(context, param, "Method");
     if (isApiVersion(context, param) && apiVersionParam === undefined) {
       apiVersionParam = emittedParam;
@@ -768,7 +770,7 @@ function emitBasicOperation(
         innerResponse
       );
       if (isErrorModel(context.program, response.type)) {
-        // * is valid status code in cadl but invalid for autorest.python
+        // * is valid status code in typespec but invalid for autorest.python
         if (response.statusCode === "*") {
           exceptions.push(emittedResponse);
         }
@@ -820,7 +822,7 @@ function emitBasicOperation(
 }
 
 function isReadOnly(program: Program, type: ModelProperty): boolean {
-  // https://microsoft.github.io/cadl/standard-library/rest/operations#automatic-visibility
+  // https://microsoft.github.io/typespec/standard-library/http/operations#automatic-visibility
   // Only "read" should be readOnly
   const visibility = getVisibility(program, type);
   if (visibility) {
@@ -834,6 +836,7 @@ function emitProperty(
   context: SdkContext,
   property: ModelProperty
 ): Record<string, any> {
+  const newProperty = applyEncoding(context.program, property, property);
   let clientDefaultValue = undefined;
   const propertyDefaultKind = property.default?.kind;
   if (
@@ -845,6 +848,10 @@ function emitProperty(
     clientDefaultValue = property.default.value;
   }
 
+  if (propertyDefaultKind === "EnumMember") {
+    clientDefaultValue = property.default.value ?? property.default.name;
+  }
+
   // const [clientName, jsonName] = getPropertyNames(context, property);
   const clientName = property.name;
   const jsonName =
@@ -853,16 +860,18 @@ function emitProperty(
   if (property.model) {
     getType(context, property.model);
   }
+  const type = getType(context, property.type);
   return {
     clientName: applyCasing(clientName, { casing: CASING }),
     restApiName: jsonName,
-    type: getType(context, property.type),
+    type: newProperty.format ? { ...type, format: newProperty.format } : type,
     optional: property.optional,
     description: getDocStr(context.program, property),
     addedOn: getAddedOnVersion(context.program, property),
     readonly:
       isReadOnly(context.program, property) || isKey(context.program, property),
-    clientDefaultValue: clientDefaultValue
+    clientDefaultValue: clientDefaultValue,
+    format: newProperty.format
   };
 }
 
@@ -896,9 +905,35 @@ function emitModel(context: SdkContext, type: Model): Record<string, any> {
     baseModel = getType(context, type.baseModel);
   }
   const effectiveName = getEffectiveSchemaType(context.program, type).name;
-  const modelName = effectiveName
-    ? effectiveName
-    : getName(context.program, type);
+  const overridedModelName =
+    getProjectedName(context.program, type, "javascript") ??
+    getProjectedName(context.program, type, "client") ??
+    getFriendlyName(context.program, type);
+  let modelName =
+    overridedModelName ??
+    (effectiveName ? effectiveName : getName(context.program, type));
+  if (
+    !overridedModelName &&
+    type.templateMapper &&
+    type.templateMapper.args &&
+    type.templateMapper.args.length > 0 &&
+    getPagedResult(context.program, type)
+  ) {
+    modelName =
+      type.templateMapper.args
+        .map((it) => {
+          switch (it.kind) {
+            case "Model":
+              return it.name;
+            case "String":
+              return it.value;
+            default:
+              return "";
+          }
+        })
+        .join("") + "List";
+  }
+
   return {
     type: "model",
     name: modelName,
@@ -1000,9 +1035,10 @@ function emitStdScalar(
   program: Program,
   scalar: Scalar & { name: IntrinsicScalarName }
 ): Record<string, any> {
+  const newScalar = applyEncoding(program, scalar, scalar);
   switch (scalar.name) {
     case "bytes":
-      return { type: "byte-array", format: getEncode(program, scalar) };
+      return { type: "byte-array", format: newScalar.format };
     case "int8":
     case "int16":
     case "int32":
@@ -1024,13 +1060,15 @@ function emitStdScalar(
     case "boolean":
       return { type: "boolean" };
     case "plainDate":
-      return { type: "date" };
+      return { type: "datetime", format: newScalar.format ?? "date" };
     case "utcDateTime":
-      return { type: "datetime", format: "date-time" };
+      return { type: "datetime", format: newScalar.format };
     case "plainTime":
-      return { type: "time" };
+      return { type: "datetime", format: newScalar.format ?? "time" };
+    case "offsetDateTime":
+      return { type: "datetime", format: newScalar.format ?? "rfc7231" };
     case "duration":
-      return { type: "duration" };
+      return { type: "duration", format: newScalar.format };
     case "numeric":
       return {}; // Waiting on design for more precise type https://github.com/microsoft/cadl/issues/1260
     default:
@@ -1038,12 +1076,51 @@ function emitStdScalar(
   }
 }
 
+function applyEncoding(
+  program: Program,
+  typespecType: Scalar | ModelProperty,
+  target: any = {}
+) {
+  const encodeData = getEncode(program, typespecType);
+  const formatData = getFormat(program, typespecType);
+  formatData;
+  if (encodeData) {
+    const newTarget = { ...target };
+    const newType = emitScalar(program, encodeData.type);
+    // newTarget["type"] = newType["type"];
+    // If the target already has a format it takes priority. (e.g. int32)
+    newTarget["format"] = mergeFormatAndEncoding(
+      newTarget.format,
+      encodeData.encoding,
+      newType["format"]
+    );
+    return newTarget;
+  }
+  return target;
+}
+
+function mergeFormatAndEncoding(
+  format: string | undefined,
+  encoding: string,
+  encodeAsFormat: string | undefined
+): string {
+  switch (format) {
+    case undefined:
+      return encodeAsFormat ?? encoding;
+    case "date-time":
+      return encoding;
+    case "duration":
+    default:
+      return encodeAsFormat ?? encoding;
+  }
+}
+
 function applyIntrinsicDecorators(
   program: Program,
   type: Scalar | ModelProperty,
   result: any
 ): Record<string, any> {
-  const newResult = { ...result };
+  let newResult = { ...result };
   const docStr = getDoc(program, type);
   const isString = isStringType(program, getPropertyType(type));
   const isNumeric = isNumericType(program, getPropertyType(type));
@@ -1052,10 +1129,7 @@ function applyIntrinsicDecorators(
     newResult.description = docStr;
   }
 
-  const formatStr = getFormat(program, type);
-  if (isString && !result.format && formatStr) {
-    newResult.format = formatStr;
-  }
+  newResult = applyEncoding(program, type, newResult);
 
   const pattern = getPattern(program, type);
   if (isString && !result.pattern && pattern) {
@@ -1096,7 +1170,8 @@ function applyIntrinsicDecorators(
 
 function emitScalar(program: Program, scalar: Scalar): Record<string, any> {
   let result: Record<string, any> = {};
-  if (program.checker.isStdType(scalar)) {
+  const isStd = program.checker.isStdType(scalar);
+  if (isStd) {
     result = emitStdScalar(program, scalar);
   } else if (scalar.baseScalar) {
     result = emitScalar(program, scalar.baseScalar);
@@ -1127,7 +1202,7 @@ function emitListOrDict(
   return undefined;
 }
 
-function mapCadlType(context: SdkContext, type: Type): any {
+function mapTypeSpecType(context: SdkContext, type: Type): any {
   switch (type.kind) {
     case "Number":
       return constantType(type.value, intOrFloat(type.value));
@@ -1228,7 +1303,7 @@ function emitType(context: SdkContext, type: EmitterType): Record<string, any> {
   if (type.kind === "CredentialTypeUnion") {
     return emitCredentialUnion(type);
   }
-  const builtinType = mapCadlType(context, type);
+  const builtinType = mapTypeSpecType(context, type);
   if (builtinType !== undefined) {
     // add in description elements for types derived from primitive types (SecureString, etc.)
     const doc = getDoc(context.program, type);
@@ -1288,9 +1363,38 @@ function emitOperationGroups(
       operations: clientOperations
     });
   }
+  resolveConflictIfExist(operationGroups);
   return operationGroups;
 }
 
+function resolveConflictIfExist(operationGroups: OperationGroup[]) {
+  if (operationGroups.length < 2) {
+    return;
+  }
+
+  const nameSet = new Set<string>();
+  const hasConflict = operationGroups.some((g) =>
+    g.operations.some((op) => {
+      if (nameSet.has(op.name)) {
+        return true;
+      } else {
+        nameSet.add(op.name);
+        return false;
+      }
+    })
+  );
+  if (!hasConflict) {
+    return;
+  }
+  // Append operation group prefix
+  operationGroups.forEach((g) =>
+    g.operations.forEach((op) => {
+      op.oriName = op.name;
+      op.name = `${g.propertyName}_${op.name}`;
+    })
+  );
+}
+
 function getServerHelper(
   program: Program,
   namespace: Namespace
@@ -1468,7 +1572,8 @@ function emitClients(
       operationGroups: emitOperationGroups(context, client, rlcModels),
       url: server ? server.url : "",
       apiVersions: [],
-      rlcClientName: rlcModels ? getClientName(rlcModels) : client.name
+      rlcClientName: rlcModels ? getClientName(rlcModels) : client.name,
+      subfolder: ""
     };
     const emittedApiVersionParam = getApiVersionParameter(context);
     if (emittedApiVersionParam) {
@@ -1501,23 +1606,28 @@ function getNamespaces(context: SdkContext): Set<string> {
 }
 
 export function emitCodeModel(
-  context: EmitContext<EmitterOptions>,
+  dpgContext: SdkContext,
   rlcModelsMap: Map<string, RLCModel>,
+  modularSourcesRoot: string,
+  project: Project,
   options: { casing: "snake" | "camel" } = { casing: "snake" }
 ): ModularCodeModel {
   CASING = options.casing ?? CASING;
-  const dpgContext = createSdkContext(context);
   const clientNamespaceString =
     getClientNamespaceString(dpgContext)?.toLowerCase();
   // Get types
   const codeModel: ModularCodeModel = {
-    options: transformRLCOptions(context.options as any, dpgContext),
+    options: dpgContext.rlcOptions ?? {},
+    modularOptions: { sourceRoot: modularSourcesRoot },
     namespace: clientNamespaceString,
     subnamespaceToClients: {},
     clients: [],
-    types: []
+    types: [],
+    project
   };
 
+  typesMap.clear();
+  simpleTypesMap.clear();
   const allModels = getAllModels(dpgContext);
   for (const model of allModels) {
     getType(dpgContext, model);
@@ -1526,12 +1636,25 @@ export function emitCodeModel(
   for (const namespace of getNamespaces(dpgContext)) {
     if (namespace === clientNamespaceString) {
       codeModel.clients = emitClients(dpgContext, namespace, rlcModelsMap);
+      codeModel.clients.length > 1 &&
+        codeModel.clients.map((client) => {
+          client["subfolder"] = normalizeName(
+            client.name.replace("Client", ""),
+            NameType.File
+          );
+        });
     } else {
       codeModel["subnamespaceToClients"][namespace] = emitClients(
         dpgContext,
         namespace,
         rlcModelsMap
       );
+      codeModel["subnamespaceToClients"][namespace].length > 1 &&
+        (codeModel["subnamespaceToClients"][namespace] as HrlcClient[]).map(
+          (client) => {
+            client["subfolder"] = normalizeName(client.name, NameType.File);
+          }
+        );
     }
   }
 

package/src/modular/buildOperations.ts

@@ -7,7 +7,7 @@ import {
   getDeserializePrivateFunction,
   getOperationOptionsName
 } from "./helpers/operationHelpers.js";
-import { Client, Operation } from "./modularCodeModel.js";
+import { Client, ModularCodeModel, Operation } from "./modularCodeModel.js";
 import { isRLCMultiEndpoint } from "../utils/clientUtils.js";
 import { getDocsFromDescription } from "./helpers/docsHelpers.js";
 import { SdkContext } from "../utils/interfaces.js";
@@ -19,12 +19,11 @@ import { SdkContext } from "../utils/interfaces.js";
  */
 export function buildOperationFiles(
   dpgContext: SdkContext,
+  codeModel: ModularCodeModel,
   client: Client,
-  project: Project,
-  srcPath: string = "src",
-  subfolder: string = "",
   needUnexpectedHelper: boolean = true
 ) {
+  const operationFiles = [];
   for (const operationGroup of client.operationGroups) {
     const importSet: Map<string, Set<string>> = new Map<string, Set<string>>();
     const fileName = operationGroup.className
@@ -33,7 +32,9 @@ export function buildOperationFiles(
         // into a nameless operation group. We'll call this operations.
         "operations";
 
-    const operationGroupFile = project.createSourceFile(
+    const subfolder = client.subfolder;
+    const srcPath = codeModel.modularOptions.sourceRoot;
+    const operationGroupFile = codeModel.project.createSourceFile(
       `${srcPath}/${
         subfolder && subfolder !== "" ? subfolder + "/" : ""
       }api/${fileName}.ts`
@@ -41,7 +42,7 @@ export function buildOperationFiles(
 
     // 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, operationGroupFile, project, subfolder);
+    importModels(srcPath, operationGroupFile, codeModel.project, subfolder);
 
     const namedImports: string[] = [];
     let clientType = "Client";
@@ -114,7 +115,9 @@ export function buildOperationFiles(
     operationGroupFile.fixMissingImports();
     // have to fixUnusedIdentifiers after everything get generated.
     operationGroupFile.fixUnusedIdentifiers();
+    operationFiles.push(operationGroupFile);
   }
+  return operationFiles;
 }
 
 export function importModels(
@@ -134,10 +137,12 @@ export function importModels(
     models.push(entry[0]);
   }
 
-  sourceFile.addImportDeclaration({
-    moduleSpecifier: "../models/models.js",
-    namedImports: models
-  });
+  if (models.length > 0) {
+    sourceFile.addImportDeclaration({
+      moduleSpecifier: "../models/models.js",
+      namedImports: models
+    });
+  }
 
   // Import all models and then let ts-morph clean up the unused ones
   // we can't fixUnusedIdentifiers here because the operaiton files are still being generated.
@@ -169,7 +174,7 @@ export function buildOperationOptions(
       return {
         docs: getDocsFromDescription(p.description),
         hasQuestionToken: true,
-        ...buildType(p.clientName, p.type)
+        ...buildType(p.clientName, p.type, p.format)
       };
     })
   });

package/src/modular/buildProjectFiles.ts

@@ -100,7 +100,7 @@ export function emitPackage(
         generateSample
       )}`,
       clean:
-        "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log",
+        "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
       "execute:samples": "echo skipped",
       "extract-api":
         "rimraf review && mkdirp ./review && api-extractor run --local",
@@ -156,7 +156,7 @@ export function emitPackage(
       eslint: "^8.0.0",
       mkdirp: "^2.1.2",
       prettier: "^2.5.1",
-      rimraf: "^3.0.0",
+      rimraf: "^5.0.0",
       "source-map-support": "^0.5.9",
       typescript: "~5.0.0"
     }

package/src/modular/buildRootIndex.ts

@@ -1,14 +1,15 @@
 import { Project, SourceFile } from "ts-morph";
 import { getClientName } from "./helpers/namingHelpers.js";
-import { Client } from "./modularCodeModel.js";
+import { Client, ModularCodeModel } from "./modularCodeModel.js";
 
 export function buildRootIndex(
+  codeModel: ModularCodeModel,
   client: Client,
-  project: Project,
-  rootIndexFile: SourceFile,
-  srcPath: string,
-  subfolder: string
+  rootIndexFile: SourceFile
 ) {
+  const { project } = codeModel;
+  const srcPath = codeModel.modularOptions.sourceRoot;
+  const subfolder = client.subfolder ?? "";
   const clientName = `${getClientName(client)}Client`;
   const clientFile = project.getSourceFile(
     `${srcPath}/${subfolder !== "" ? subfolder + "/" : ""}${clientName}.ts`
@@ -71,12 +72,12 @@ function exportModels(
 }
 
 export function buildSubClientIndexFile(
-  client: Client,
-  project: Project,
-  srcPath: string,
-  subfolder: string
+  codeModel: ModularCodeModel,
+  client: Client
 ) {
-  const subClientIndexFile = project.createSourceFile(
+  const subfolder = client.subfolder ?? "";
+  const srcPath = codeModel.modularOptions.sourceRoot;
+  const subClientIndexFile = codeModel.project.createSourceFile(
     `${srcPath}/${subfolder !== "" ? subfolder + "/" : ""}index.ts`,
     undefined,
     { overwrite: true }
@@ -85,12 +86,18 @@ export function buildSubClientIndexFile(
   const clientFilePath = `${srcPath}/${
     subfolder !== "" ? subfolder + "/" : ""
   }${clientName}.ts`;
-  const clientFile = project.getSourceFile(clientFilePath);
+  const clientFile = codeModel.project.getSourceFile(clientFilePath);
 
   if (!clientFile) {
     throw new Error(`Couldn't find client file: ${clientFilePath}`);
   }
 
   exportClassicalClient(client, subClientIndexFile, subfolder, true);
-  exportModels(subClientIndexFile, project, srcPath, clientName, subfolder);
+  exportModels(
+    subClientIndexFile,
+    codeModel.project,
+    srcPath,
+    clientName,
+    subfolder
+  );
 }