@azure-tools/typespec-ts 0.54.0 → 0.54.1

package/src/framework/hooks/sdkTypes.ts

@@ -1,4 +1,3 @@
-import { Operation, Type, getNamespaceFullName } from "@typespec/compiler";
 import {
   SdkClientType,
   SdkHttpOperation,
@@ -6,23 +5,23 @@ import {
   SdkModelType,
   SdkServiceMethod,
   SdkType,
-  getClientType
+  getClientType,
 } from "@azure-tools/typespec-client-generator-core";
+import { Operation, Type, getNamespaceFullName } from "@typespec/compiler";
 import { provideContext, useContext } from "../../contextManager.js";
 
+import { reportDiagnostic } from "../../lib.js";
 import { visitPackageTypes } from "../../modular/emitModels.js";
-import { SdkContext } from "../../utils/interfaces.js";
-import {
-  getAllAncestors,
-  getAllProperties
-} from "../../modular/helpers/operationHelpers.js";
+import { getAllAncestors, getAllProperties } from "../../modular/helpers/operationHelpers.js";
 import { normalizeModelPropertyName } from "../../modular/type-expressions/get-type-expression.js";
-import { reportDiagnostic } from "../../lib.js";
 import { NameType, normalizeName } from "../../rlc-common/index.js";
+import { SdkContext } from "../../utils/interfaces.js";
 
 export const emitQueue: Set<SdkType> = new Set<SdkType>();
-export const flattenPropertyModelMap: Map<SdkModelPropertyType, SdkModelType> =
-  new Map<SdkModelPropertyType, SdkModelType>();
+export const flattenPropertyModelMap: Map<SdkModelPropertyType, SdkModelType> = new Map<
+  SdkModelPropertyType,
+  SdkModelType
+>();
 /**
  * Set of paged result models that are also used in non-paging operations.
  * Precomputed during visitPackageTypes for O(1) lookups in normalizeModelName.
@@ -46,16 +45,13 @@ export function useSdkTypes() {
 
   function getSdkType(type: Operation): SdkServiceMethod<SdkHttpOperation>;
   function getSdkType(type: Type): SdkType;
-  function getSdkType(
-    type: Type | Operation
-  ): SdkType | SdkServiceMethod<SdkHttpOperation> {
+  function getSdkType(type: Type | Operation): SdkType | SdkServiceMethod<SdkHttpOperation> {
     let sdkType: SdkType | SdkServiceMethod<SdkHttpOperation> | undefined;
 
     if (type.kind === "Operation") {
       sdkType = sdkTypesContext.operations.get(type);
     } else {
-      sdkType =
-        sdkTypesContext.types.get(type) ?? getClientType(tcgcContext, type);
+      sdkType = sdkTypesContext.types.get(type) ?? getClientType(tcgcContext, type);
     }
 
     if (!sdkType) {
@@ -63,10 +59,8 @@ export function useSdkTypes() {
         `SdkType not found for type: ${type.kind} ${
           "name" in type && typeof type.name == "string" ? type.name : ""
         } ${
-          "namespace" in type && type.namespace
-            ? ` in ${getNamespaceFullName(type.namespace)}`
-            : ""
-        }`
+          "namespace" in type && type.namespace ? ` in ${getNamespaceFullName(type.namespace)}` : ""
+        }`,
       );
     }
 
@@ -81,17 +75,10 @@ export function provideSdkTypes(context: SdkContext) {
   const sdkTypesContext: SdkTypeContext = {
     operations: new Map<Type, SdkServiceMethod<SdkHttpOperation>>(),
     types: new Map<Type, SdkType>(),
-    flattenProperties: new Map<
-      SdkModelPropertyType,
-      SdkFlattenPropertyContext
-    >()
+    flattenProperties: new Map<SdkModelPropertyType, SdkFlattenPropertyContext>(),
   };
   visitPackageTypes(context);
-  enrichFlattenProperties(
-    context,
-    sdkTypesContext.flattenProperties,
-    flattenPropertyModelMap
-  );
+  enrichFlattenProperties(context, sdkTypesContext.flattenProperties, flattenPropertyModelMap);
   for (const sdkModel of emitQueue) {
     switch (sdkModel.kind) {
       case "model":
@@ -117,16 +104,10 @@ export function provideSdkTypes(context: SdkContext) {
         });
         break;
       case "array":
-        sdkTypesContext.types.set(
-          sdkModel.valueType.__raw!,
-          sdkModel.valueType
-        );
+        sdkTypesContext.types.set(sdkModel.valueType.__raw!, sdkModel.valueType);
         break;
       case "dict":
-        sdkTypesContext.types.set(
-          sdkModel.valueType.__raw!,
-          sdkModel.valueType
-        );
+        sdkTypesContext.types.set(sdkModel.valueType.__raw!, sdkModel.valueType);
         break;
       case "nullable":
         sdkTypesContext.types.set(sdkModel.__raw!, sdkModel);
@@ -161,7 +142,7 @@ export function provideSdkTypes(context: SdkContext) {
 function enrichFlattenProperties(
   context: SdkContext,
   propertyContextMap: Map<SdkModelPropertyType, SdkFlattenPropertyContext>,
-  propertyModelMap: Map<SdkModelPropertyType, SdkModelType>
+  propertyModelMap: Map<SdkModelPropertyType, SdkModelType>,
 ) {
   // Build a map of base model to its existing properties excluding flatten properties
   // To check for conflicts later
@@ -171,19 +152,16 @@ function enrichFlattenProperties(
       const propertiesExcludedFlatten = getAllProperties(
         context,
         baseModel,
-        getAllAncestors(baseModel)
+        getAllAncestors(baseModel),
       )
         .filter((p) => !(p.flatten && p.type.kind === "model"))
         .map((p) => normalizeModelPropertyName(context, p));
-      baseModelProperties.set(
-        baseModel,
-        new Set<string>(propertiesExcludedFlatten)
-      );
+      baseModelProperties.set(baseModel, new Set<string>(propertiesExcludedFlatten));
     }
   });
   for (const [flattenProperty, baseModel] of propertyModelMap) {
     const flattenContext: SdkFlattenPropertyContext = {
-      baseModel: baseModel
+      baseModel: baseModel,
     };
     propertyContextMap.set(flattenProperty, flattenContext);
     const existingProperties = baseModelProperties.get(baseModel)!;
@@ -197,25 +175,22 @@ function enrichFlattenProperties(
         code: "unsupported-flatten-transition",
         format: {
           propertyName: flattenProperty.name,
-          modelName: baseModel.name
+          modelName: baseModel.name,
         },
-        target: flattenProperty.__raw!
+        target: flattenProperty.__raw!,
       });
     }
     const allFlattenProperties = getAllProperties(
       context,
       flattenModel,
-      getAllAncestors(flattenModel)
+      getAllAncestors(flattenModel),
     );
     for (const flattenChildProperty of allFlattenProperties) {
-      let childPropertyName = normalizeModelPropertyName(
-        context,
-        flattenChildProperty
-      );
+      let childPropertyName = normalizeModelPropertyName(context, flattenChildProperty);
       if (existingProperties.has(childPropertyName)) {
         childPropertyName = normalizeName(
           `${childPropertyName}_${flattenProperty.name}_${childPropertyName}`,
-          NameType.Property
+          NameType.Property,
         );
         conflictMap.set(flattenChildProperty, childPropertyName);
       }
@@ -228,9 +203,7 @@ function enrichFlattenProperties(
   }
 }
 
-export function getAllOperationsFromClient(
-  client: SdkClientType<SdkHttpOperation>
-) {
+export function getAllOperationsFromClient(client: SdkClientType<SdkHttpOperation>) {
   const clientQueue = [client];
   const operations: SdkServiceMethod<SdkHttpOperation>[] = [];
   while (clientQueue.length > 0) {

package/src/framework/hooks/useDependencies.ts

@@ -2,12 +2,10 @@ import { provideContext, useContext } from "../../contextManager.js";
 import { DefaultCoreDependencies } from "../../modular/external-dependencies.js";
 import { ExternalDependencies } from "../dependency.js";
 
-export function provideDependencies(
-  customDependencies: Partial<ExternalDependencies> = {}
-) {
+export function provideDependencies(customDependencies: Partial<ExternalDependencies> = {}) {
   const dependencies = {
     ...DefaultCoreDependencies,
-    ...customDependencies
+    ...customDependencies,
   } as ExternalDependencies;
 
   provideContext("dependencies", dependencies);

package/src/framework/load-static-helpers.ts

@@ -1,4 +1,5 @@
-import { readdir, stat, readFile } from "fs/promises";
+import { NoTarget, Program } from "@typespec/compiler";
+import { readdir, readFile, stat } from "fs/promises";
 import * as path from "path";
 import {
   ClassDeclaration,
@@ -7,14 +8,13 @@ import {
   InterfaceDeclaration,
   Project,
   SourceFile,
-  TypeAliasDeclaration
+  TypeAliasDeclaration,
 } from "ts-morph";
-import { refkey } from "./refkey.js";
-import { resolveProjectRoot } from "../utils/resolve-project-root.js";
-import { isAzurePackage } from "../rlc-common/index.js";
-import { ModularEmitterOptions } from "../modular/interfaces.js";
-import { NoTarget, Program } from "@typespec/compiler";
 import { reportDiagnostic } from "../lib.js";
+import { ModularEmitterOptions } from "../modular/interfaces.js";
+import { isAzurePackage } from "../rlc-common/index.js";
+import { resolveProjectRoot } from "../utils/resolve-project-root.js";
+import { refkey } from "./refkey.js";
 export const SourceFileSymbol = Symbol("SourceFile");
 export interface StaticHelperMetadata {
   name: string;
@@ -23,15 +23,9 @@ export interface StaticHelperMetadata {
   [SourceFileSymbol]?: SourceFile;
 }
 
-export function isStaticHelperMetadata(
-  metadata: any
-): metadata is StaticHelperMetadata {
+export function isStaticHelperMetadata(metadata: any): metadata is StaticHelperMetadata {
   return Boolean(
-    metadata &&
-    metadata.name &&
-    metadata.kind &&
-    metadata.location &&
-    metadata[SourceFileSymbol]
+    metadata && metadata.name && metadata.kind && metadata.location && metadata[SourceFileSymbol],
   );
 }
 
@@ -57,35 +51,34 @@ interface FileMetadata {
 export async function loadStaticHelpers(
   project: Project,
   helpers: StaticHelpers,
-  options: LoadStaticHelpersOptions = {}
+  options: LoadStaticHelpersOptions = {},
 ): Promise<Map<string, StaticHelperMetadata>> {
   const helpersMap = new Map<string, StaticHelperMetadata>();
   // Load static helpers used in sources code
   const defaultStaticHelpersPath = path.join(
     resolveProjectRoot(),
-    DEFAULT_SOURCES_STATIC_HELPERS_PATH
+    DEFAULT_SOURCES_STATIC_HELPERS_PATH,
   );
   const filesInSources = await traverseDirectory(
     options.helpersAssetDirectory ?? defaultStaticHelpersPath,
-    options.program
+    options.program,
   );
   await loadFiles(filesInSources, options.sourcesDir ?? "");
   // Load static helpers used in testing code (only when loadTestHelpers is enabled)
   if (
     options.loadTestHelpers ??
-    (options.options?.generateTest &&
-      isAzurePackage({ options: options.options }))
+    (options.options?.generateTest && isAzurePackage({ options: options.options }))
   ) {
     const defaultTestingHelpersPath = path.join(
       resolveProjectRoot(),
-      DEFAULT_SOURCES_TESTING_HELPERS_PATH
+      DEFAULT_SOURCES_TESTING_HELPERS_PATH,
     );
     const filesInTestings = await traverseDirectory(
       defaultTestingHelpersPath,
       options.program,
       [],
       "",
-      "test/generated/util"
+      "test/generated/util",
     );
     await loadFiles(filesInTestings, options.rootDir ?? "");
   }
@@ -96,24 +89,14 @@ export async function loadStaticHelpers(
       const targetPath = path.join(generateDir, file.target);
       const contents = await readFile(file.source, "utf-8");
       const addedFile = project.createSourceFile(targetPath, contents, {
-        overwrite: true
+        overwrite: true,
       });
       addedFile.getImportDeclarations().map((i) => {
         if (!isAzurePackage({ options: options.options })) {
-          if (
-            i
-              .getModuleSpecifier()
-              .getFullText()
-              .includes("@azure/core-rest-pipeline")
-          ) {
+          if (i.getModuleSpecifier().getFullText().includes("@azure/core-rest-pipeline")) {
             i.setModuleSpecifier("@typespec/ts-http-runtime");
           }
-          if (
-            i
-              .getModuleSpecifier()
-              .getFullText()
-              .includes("@azure-rest/core-client")
-          ) {
+          if (i.getModuleSpecifier().getFullText().includes("@azure-rest/core-client")) {
             i.setModuleSpecifier("@typespec/ts-http-runtime");
           }
         }
@@ -144,7 +127,7 @@ export async function loadStaticHelpers(
           throw new Error(
             `Declaration ${
               entry.name
-            } not found in file ${addedFile.getFilePath()}\n This is an Emitter bug, make sure that the map of static helpers passed to loadStaticHelpers matches what is in the file.`
+            } not found in file ${addedFile.getFilePath()}\n This is an Emitter bug, make sure that the map of static helpers passed to loadStaticHelpers matches what is in the file.`,
           );
         }
 
@@ -155,9 +138,7 @@ export async function loadStaticHelpers(
   }
 }
 
-function assertAllHelpersLoadedPresent(
-  helpers: Map<string, StaticHelperMetadata>
-) {
+function assertAllHelpersLoadedPresent(helpers: Map<string, StaticHelperMetadata>) {
   const missingHelpers = [];
   for (const helper of helpers.values()) {
     if (!helper[SourceFileSymbol]) {
@@ -171,7 +152,7 @@ function assertAllHelpersLoadedPresent(
       .join("\n");
 
     throw new Error(
-      `The following helpers were not found in the project, make sure they are defined in the expected static helper file: ${missingHelpersString}`
+      `The following helpers were not found in the project, make sure they are defined in the expected static helper file: ${missingHelpersString}`,
     );
   }
 
@@ -180,7 +161,7 @@ function assertAllHelpersLoadedPresent(
 
 function getDeclarationByMetadata(
   file: SourceFile,
-  declaration: StaticHelperMetadata
+  declaration: StaticHelperMetadata,
 ):
   | ClassDeclaration
   | FunctionDeclaration
@@ -201,7 +182,7 @@ function getDeclarationByMetadata(
       return file.getEnum(declaration.name);
     default:
       throw new Error(
-        `invalid helper kind ${declaration.kind}\nAll helpers provided to loadStaticHelpers are of kind: function, interface, typeAlias, class`
+        `invalid helper kind ${declaration.kind}\nAll helpers provided to loadStaticHelpers are of kind: function, interface, typeAlias, class`,
       );
   }
 }
@@ -212,7 +193,7 @@ async function traverseDirectory(
   program?: Program,
   result: { source: string; target: string }[] = [],
   relativePath: string = "",
-  targetBaseDir: string = _targetStaticHelpersBaseDir
+  targetBaseDir: string = _targetStaticHelpersBaseDir,
 ): Promise<{ source: string; target: string }[]> {
   try {
     const files = await readdir(directory);
@@ -228,17 +209,13 @@ async function traverseDirectory(
             program,
             result,
             path.join(relativePath, file),
-            targetBaseDir
+            targetBaseDir,
           );
-        } else if (
-          fileStat.isFile() &&
-          !file.endsWith(".d.ts") &&
-          /.*\..?ts$/.test(file)
-        ) {
+        } else if (fileStat.isFile() && !file.endsWith(".d.ts") && /.*\..?ts$/.test(file)) {
           const target = path.join(targetBaseDir, relativePath, file);
           result.push({ source: filePath, target });
         }
-      })
+      }),
     );
 
     return result;
@@ -247,7 +224,7 @@ async function traverseDirectory(
       reportDiagnostic(program, {
         code: "directory-traversal-error",
         format: { directory, error: String(error) },
-        target: NoTarget
+        target: NoTarget,
       });
     }
     throw error;

package/src/framework/reference.ts

@@ -1,10 +1,7 @@
+import { ReferenceableSymbol } from "./dependency.js";
 import { useBinder } from "./hooks/binder.js";
+import { SourceFileSymbol, StaticHelperMetadata } from "./load-static-helpers.js";
 import { refkey as getRefkey } from "./refkey.js";
-import { ReferenceableSymbol } from "./dependency.js";
-import {
-  SourceFileSymbol,
-  StaticHelperMetadata
-} from "./load-static-helpers.js";
 
 export function resolveReference(refkey: unknown): string {
   const binder = useBinder();

package/src/framework/sample.ts

@@ -1,11 +1,11 @@
 import {
+  FunctionDeclarationStructure,
+  InterfaceDeclarationStructure,
   Project,
   StructureKind,
-  InterfaceDeclarationStructure,
-  FunctionDeclarationStructure
 } from "ts-morph";
-import { useBinder } from "./hooks/binder.js";
 import { addDeclaration } from "./declaration.js";
+import { useBinder } from "./hooks/binder.js";
 import { resolveReference } from "./reference.js";
 
 // Create a new ts-morph project
@@ -21,14 +21,14 @@ const binder = useBinder();
 // 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" }]
+  properties: [{ name: "id", type: "number" }],
 };
 
 // Define a function model
 const functionType = {
   name: "MyFunction",
   returnType: "void",
-  body: `console.log("Hello World");`
+  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.
@@ -37,8 +37,8 @@ const interfaceDeclaration: InterfaceDeclarationStructure = {
   name: modelType.name,
   properties: modelType.properties.map((p) => ({
     name: p.name,
-    type: p.type
-  }))
+    type: p.type,
+  })),
 };
 
 // Create a function declaration structure
@@ -46,7 +46,7 @@ const functionDeclaration: FunctionDeclarationStructure = {
   kind: StructureKind.Function,
   name: functionType.name,
   returnType: functionType.returnType,
-  statements: functionType.body
+  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.
@@ -56,7 +56,7 @@ addDeclaration(sourceFile, functionDeclaration, functionType);
 
 // Create another source file
 const sourceFile2 = project.createSourceFile("test2.ts", "", {
-  overwrite: true
+  overwrite: true,
 });
 
 // Add statements referencing the tracked declarations