@azure-tools/typespec-ts 0.13.0 → 0.13.1

package/src/modular/helpers/typeHelpers.ts

@@ -7,41 +7,52 @@ export interface TypeMetadata {
   modifier?: "Array";
 }
 
+function getNullableType(name: string, type: Type): string {
+  if (type.nullable) {
+    return `(${name} | null)`;
+  }
+
+  return name;
+}
+
 export function getType(type: Type): TypeMetadata {
   switch (type.type) {
     case "Key":
       return {
-        name: "AzureKeyCredential",
+        name: "KeyCredential",
         originModule: "@azure/core-auth",
         isRelative: false
       };
     case "boolean":
-      return { name: "boolean" };
+      return { name: getNullableType(type.type, type) };
     case "constant": {
       let typeName: string = type.value ?? "undefined";
       if (type.valueType?.type === "string") {
         typeName = type.value ? `"${type.value}"` : "undefined";
       }
-      return { name: typeName };
+      return { name: getNullableType(typeName, type) };
     }
     case "datetime":
-      return { name: "Date" };
+      return { name: getNullableType("Date", type) };
     case "enum":
       if (!type.name) {
         throw new Error("Unable to process enum without name");
       }
-      return { name: type.name, originModule: "models.js" };
+      return {
+        name: getNullableType(type.name, type),
+        originModule: "models.js"
+      };
     case "float":
     case "integer":
-      return { name: "number" };
+      return { name: getNullableType("number", type) };
     case "byte-array":
-      return { name: "string" };
+      return { name: getNullableType("Uint8Array", type) };
     case "list":
       if (!type.elementType) {
         throw new Error("Unable to process Array with no elementType");
       }
       return {
-        name: getType(type.elementType).name,
+        name: getNullableType(getType(type.elementType).name, type),
         modifier: "Array",
         originModule:
           type.elementType?.type === "model" ? "models.js" : undefined
@@ -50,10 +61,13 @@ export function getType(type: Type): TypeMetadata {
       if (!type.name) {
         throw new Error("Unable to process model without name");
       }
-      return { name: type.name, originModule: "models.js" };
+      return {
+        name: getNullableType(type.name, type),
+        originModule: "models.js"
+      };
     case "string":
     case "duration":
-      return { name: "string" };
+      return { name: getNullableType("string", type) };
     case "combined": {
       if (!type.types) {
         throw new Error("Unable to process combined without combinedTypes");
@@ -64,7 +78,7 @@ export function getType(type: Type): TypeMetadata {
           return `${sdkType}`;
         })
         .join(" | ");
-      return { name };
+      return { name: getNullableType(name, type) };
     }
     case "dict":
       if (!type.elementType) {
@@ -73,8 +87,15 @@ export function getType(type: Type): TypeMetadata {
       return {
         name: `Record<string, ${getTypeName(getType(type.elementType))}>`
       };
+    case "any":
+      return {
+        name: `Record<string, any>`
+      };
     default:
-      throw new Error(`Unsupported type ${type.type}`);
+      // throw new Error(`Unsupported type ${type.type}`);
+      return {
+        name: `any`
+      };
   }
 }
 

package/src/modular/modularCodeModel.ts

@@ -52,6 +52,7 @@ export interface EnumValue {
   description: string;
 }
 export interface Type {
+  nullable?: boolean;
   name?: string;
   description?: string;
   type:
@@ -70,7 +71,8 @@ export interface Type {
     | "float"
     | "boolean"
     | "dict"
-    | "combined";
+    | "combined"
+    | "any";
   policy?: Policy;
   apiVersions?: any[];
   clientDefaultValue?: any;

package/src/operationUtil.ts

@@ -33,6 +33,7 @@ import {
   OPERATION_LRO_LOW_PRIORITY,
   OPERATION_LRO_HIGH_PRIORITY
 } from "@azure-tools/rlc-common";
+import { isByteOrByteUnion } from "./modelUtils.js";
 
 export function getNormalizedOperationName(
   route: HttpOperation,
@@ -74,11 +75,15 @@ export function isDefinedStatusCode(statusCode: StatusCode) {
   return statusCode !== "*";
 }
 
-export function isBinaryPayload(body: Type, contentType: string) {
+export function isBinaryPayload(
+  program: Program,
+  dpgContext: SdkContext,
+  body: Type,
+  contentType: string
+) {
   contentType = `"${contentType}"`;
   if (
-    body.kind === "Scalar" &&
-    body.name === "bytes" &&
+    isByteOrByteUnion(program, dpgContext, body) &&
     contentType !== `"application/json"` &&
     contentType !== `"text/plain"` &&
     contentType !== `"application/json" | "text/plain"` &&
@@ -207,6 +212,10 @@ export function hasPollingOperations(
     );
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
+      // ignore overload base operation
+      if (route.overloads && route.overloads?.length > 0) {
+        continue;
+      }
       if (isLongRunningOperation(program, route)) {
         return true;
       }
@@ -215,6 +224,10 @@ export function hasPollingOperations(
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
+    // ignore overload base operation
+    if (route.overloads && route.overloads?.length > 0) {
+      continue;
+    }
     if (isLongRunningOperation(program, route)) {
       return true;
     }
@@ -246,6 +259,10 @@ export function hasPagingOperations(
     );
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
+      // ignore overload base operation
+      if (route.overloads && route.overloads?.length > 0) {
+        continue;
+      }
       if (isPagingOperation(program, route)) {
         return true;
       }
@@ -254,6 +271,10 @@ export function hasPagingOperations(
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
+    // ignore overload base operation
+    if (route.overloads && route.overloads?.length > 0) {
+      continue;
+    }
     if (isPagingOperation(program, route)) {
       return true;
     }

package/src/transform/transform.ts

@@ -63,7 +63,10 @@ export async function transformRLCModel(
   const libraryName = normalizeName(
     options.batch && (options.isModularLibrary || options.batch.length > 1)
       ? client.name
-      : options?.title ?? getDefaultService(program)?.title ?? "",
+      : options?.title ??
+          client.name ??
+          getDefaultService(program)?.title ??
+          "",
     NameType.Class
   );
   const importSet = new Map<ImportKind, Set<string>>();

package/src/transform/transformApiVersionInfo.ts

@@ -68,6 +68,10 @@ function getOperationQueryApiVersion(
     );
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
+      // ignore overload base operation
+      if (route.overloads && route.overloads?.length > 0) {
+        continue;
+      }
       const params = route.parameters.parameters.filter(
         (p) => p.type === "query" && isApiVersion(dpgContext, p)
       );
@@ -91,6 +95,10 @@ function getOperationQueryApiVersion(
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
+    // ignore overload base operation
+    if (route.overloads && route.overloads?.length > 0) {
+      continue;
+    }
     const params = route.parameters.parameters.filter(
       (p) => p.type === "query" && isApiVersion(dpgContext, p)
     );

package/src/transform/transformHelperFunctionDetails.ts

@@ -47,6 +47,10 @@ export function transformHelperFunctionDetails(
     );
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
+      // ignore overload base operation
+      if (route.overloads && route.overloads?.length > 0) {
+        continue;
+      }
       if (getPageable(program, route.operation)) {
         const nextLinkName =
           getPageable(program, route.operation) || "nextLink";
@@ -59,6 +63,10 @@ export function transformHelperFunctionDetails(
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
+    // ignore overload base operation
+    if (route.overloads && route.overloads?.length > 0) {
+      continue;
+    }
     if (getPageable(program, route.operation)) {
       const nextLinkName = getPageable(program, route.operation) || "nextLink";
       if (nextLinkName) {
@@ -112,12 +120,20 @@ function extractPageDetailFromCore(
     );
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
+      // ignore overload base operation
+      if (route.overloads && route.overloads?.length > 0) {
+        continue;
+      }
       extractPageDetailFromCoreForRoute(route);
     }
   }
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
+    // ignore overload base operation
+    if (route.overloads && route.overloads?.length > 0) {
+      continue;
+    }
     extractPageDetailFromCoreForRoute(route);
   }
 

package/src/transform/transformParameters.ts

@@ -21,10 +21,11 @@ import {
   getImportedModelName,
   getTypeName,
   getSchemaForType,
-  getBinaryType,
   getFormattedPropertyDoc,
   getBodyType,
-  predictDefaultValue
+  predictDefaultValue,
+  getBinaryType,
+  enrichBinaryTypeInBody
 } from "../modelUtils.js";
 
 import { getOperationGroupName, isBinaryPayload } from "../operationUtil.js";
@@ -53,12 +54,20 @@ export function transformToParameterTypes(
     );
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
+      // ignore overload base operation
+      if (route.overloads && route.overloads?.length > 0) {
+        continue;
+      }
       transformToParameterTypesForRoute(program, route, operationGroup);
     }
   }
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
+    // ignore overload base operation
+    if (route.overloads && route.overloads?.length > 0) {
+      continue;
+    }
     transformToParameterTypesForRoute(program, route);
   }
   if (outputImportedSet.size > 0) {
@@ -230,21 +239,25 @@ function transformBodyParameters(
   if (!bodyType) {
     return;
   }
-  const { hasBinaryContent, hasFormContent } = getBodyDetail(bodyType, headers);
+  const { hasBinaryContent, hasFormContent } = getBodyDetail(
+    program,
+    dpgContext,
+    bodyType,
+    headers
+  );
 
-  if (!hasBinaryContent && !hasFormContent) {
+  if (!hasFormContent) {
     // Case 1: Handle the normal case without binary or form data
+    // Case 2: Handle the binary body
     return transformNormalBody(
       program,
       dpgContext,
       bodyType,
       parameters,
       importedModels,
-      headers
+      headers,
+      hasBinaryContent
     );
-  } else if (hasBinaryContent) {
-    // Case 2: Handle the binary body
-    return transformBinaryBody(program, parameters);
   } else {
     // Case 3: Handle the form data
     return transformMultiFormBody(
@@ -263,14 +276,18 @@ function transformNormalBody(
   bodyType: Type,
   parameters: HttpOperationParameters,
   importedModels: Set<string>,
-  headers: ParameterMetadata[]
+  headers: ParameterMetadata[],
+  hasBinaryContent: boolean
 ) {
-  const description = extractDescriptionsFromBody(
+  const descriptions = extractDescriptionsFromBody(
     program,
     dpgContext,
     bodyType,
     parameters
-  ).join("\n\n");
+  );
+  if (hasBinaryContent) {
+    descriptions.push("Value may contain any sequence of octets");
+  }
   const type = extractNameFromCadlType(
     program,
     dpgContext,
@@ -278,7 +295,12 @@ function transformNormalBody(
     importedModels,
     headers
   );
-  const schema = getSchemaForType(program, dpgContext, bodyType);
+  let schema = getSchemaForType(program, dpgContext, bodyType);
+  let overrideType = undefined;
+  if (hasBinaryContent) {
+    schema = enrichBinaryTypeInBody(schema);
+    overrideType = schema.typeName;
+  }
   return {
     isPartialBody: false,
     body: [
@@ -286,32 +308,7 @@ function transformNormalBody(
         properties: schema.properties,
         typeName: schema.name,
         name: "body",
-        type,
-        required: parameters?.bodyParameter?.optional === false,
-        description
-      }
-    ]
-  };
-}
-
-function transformBinaryBody(
-  program: Program,
-  parameters: HttpOperationParameters
-) {
-  const descriptions: string[] = [];
-  const description =
-    parameters.bodyParameter &&
-    getFormattedPropertyDoc(program, parameters.bodyParameter, {});
-  if (description) {
-    descriptions.push(description!);
-  }
-  descriptions.push("Value may contain any sequence of octets");
-  return {
-    isPartialBody: false,
-    body: [
-      {
-        name: "body",
-        type: getBinaryType([SchemaContext.Input, SchemaContext.Exception]),
+        type: overrideType ?? type,
         required: parameters?.bodyParameter?.optional === false,
         description: descriptions.join("\n\n")
       }
@@ -395,12 +392,17 @@ function transformMultiFormBody(
   return bodyParameters;
 }
 
-function getBodyDetail(bodyType: Type, headers: ParameterMetadata[]) {
+function getBodyDetail(
+  program: Program,
+  dpgContext: SdkContext,
+  bodyType: Type,
+  headers: ParameterMetadata[]
+) {
   const contentTypes: string[] = headers
     .filter((h) => h.name === "contentType")
     .map((h) => h.param.type);
   const hasBinaryContent = contentTypes.some((c) =>
-    isBinaryPayload(bodyType, c)
+    isBinaryPayload(program, dpgContext, bodyType, c)
   );
   const hasFormContent = contentTypes.includes(`"multipart/form-data"`);
   return { hasBinaryContent, hasFormContent };

package/src/transform/transformPaths.ts

@@ -48,12 +48,20 @@ export function transformPaths(
     );
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
+      // ignore overload base operation
+      if (route.overloads && route.overloads?.length > 0) {
+        continue;
+      }
       transformOperation(program, dpgContext, route, paths, operationGroup);
     }
   }
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
+    // ignore overload base operation
+    if (route.overloads && route.overloads?.length > 0) {
+      continue;
+    }
     transformOperation(program, dpgContext, route, paths);
   }
   return paths;

package/src/transform/transformResponses.ts

@@ -52,12 +52,20 @@ export function transformToResponseTypes(
     );
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
+      // ignore overload base operation
+      if (route.overloads && route.overloads?.length > 0) {
+        continue;
+      }
       transformToResponseTypesForRoute(route, operationGroup);
     }
   }
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
+    // ignore overload base operation
+    if (route.overloads && route.overloads?.length > 0) {
+      continue;
+    }
     transformToResponseTypesForRoute(route);
   }
   if (inputImportedSet.size > 0) {
@@ -169,7 +177,7 @@ function transformBody(
       continue;
     }
     const hasBinaryContent = body.contentTypes.some((contentType) =>
-      isBinaryPayload(body.type, contentType)
+      isBinaryPayload(program, dpgContext, body.type, contentType)
     );
     if (hasBinaryContent) {
       typeSet.add(getBinaryType([SchemaContext.Output]));

package/src/transform/transformSchemas.ts

@@ -36,12 +36,20 @@ export function transformSchemas(
     );
     for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
+      // ignore overload base operation
+      if (route.overloads && route.overloads?.length > 0) {
+        continue;
+      }
       transformSchemaForRoute(route);
     }
   }
   const clientOperations = listOperationsInOperationGroup(dpgContext, client);
   for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
+    // ignore overload base operation
+    if (route.overloads && route.overloads?.length > 0) {
+      continue;
+    }
     transformSchemaForRoute(route);
   }
   function transformSchemaForRoute(route: HttpOperation) {

package/.eslintrc.json

@@ -1,23 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": { "project": "./tsconfig.json" },
-  "plugins": ["@typescript-eslint"],
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
-  "rules": {
-    "@typescript-eslint/no-non-null-assertion": "off",
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-inferrable-types": "off",
-    "@typescript-eslint/no-empty-function": "off",
-    "@typescript-eslint/no-empty-interface": "off",
-    "@typescript-eslint/no-unused-vars": [
-      "warn",
-      {
-        "varsIgnorePattern": "^_",
-        "argsIgnorePattern": ".*",
-        "ignoreRestSiblings": true
-      }
-    ],
-    "@typescript-eslint/no-floating-promises": "error",
-    "@typescript-eslint/no-misused-promises": "error"
-  }
-}

package/.prettierignore

@@ -1 +0,0 @@
-./dist

package/.prettierrc

@@ -1,7 +0,0 @@
-{
-  "trailingComma": "none",
-  "semi": true,
-  "tabWidth": 2,
-  "printWidth": 80,
-  "endOfLine": "auto"
-}

package/.rush/temp/operation/build/all.log

@@ -1 +0,0 @@
-Invoking: tsc -p . 

package/.rush/temp/operation/build/state.json

@@ -1,3 +0,0 @@
-{
-  "nonCachedDurationMs": 8820.703389000002
-}