@azure-tools/typespec-ts 0.54.0 → 0.54.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-ts",
-  "version": "0.54.0",
+  "version": "0.54.2",
   "description": "An experimental TypeSpec emitter for TypeScript RLC",
   "main": "dist/src/index.js",
   "type": "module",
@@ -18,15 +18,6 @@
   "license": "MIT",
   "devDependencies": {
     "@azure-rest/core-client": "^2.3.1",
-    "@typespec/http-specs": "0.1.0-alpha.37-dev.6",
-    "@typespec/spector": "0.1.0-dev.4",
-    "@typespec/spec-api": "0.1.0-dev.3",
-    "@typespec/tspd": "0.74.2",
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.41-dev.2",
-    "@azure-tools/typespec-autorest": "^0.68.0",
-    "@azure-tools/typespec-azure-core": "^0.68.0",
-    "@azure-tools/typespec-azure-resource-manager": "^0.68.0",
-    "@azure-tools/typespec-client-generator-core": "^0.68.3",
     "@azure/abort-controller": "^2.1.2",
     "@azure/core-auth": "^1.6.0",
     "@azure/core-lro": "^3.1.0",
@@ -34,50 +25,46 @@
     "@azure/core-rest-pipeline": "^1.14.0",
     "@azure/core-util": "^1.4.0",
     "@azure/logger": "^1.0.4",
-    "@types/chai": "^4.3.1",
-    "@types/fs-extra": "^9.0.13",
-    "@types/lodash": "^4.17.4",
-    "@typescript-eslint/eslint-plugin": "^8.28.0",
-    "@typescript-eslint/parser": "^8.28.0",
-    "@typespec/compiler": "^1.12.0",
-    "@typespec/http": "^1.12.0",
-    "@typespec/openapi": "^1.12.0",
-    "@typespec/rest": "^0.82.0",
-    "@typespec/ts-http-runtime": "^0.1.0",
-    "@typespec/versioning": "^0.82.0",
-    "@typespec/xml": "^0.82.0",
-    "chai": "^4.3.6",
-    "chalk": "^4.0.0",
-    "cross-env": "^7.0.3",
-    "eslint-plugin-require-extensions": "0.1.3",
+    "@typespec/ts-http-runtime": "0.3.5",
+    "cross-env": "^10.1.0",
     "mkdirp": "^3.0.1",
     "npm-run-all": "~4.1.5",
-    "prettier": "^3.3.3",
-    "ts-node": "~10.9.1",
-    "vitest": "^4.1.0",
-    "vite": "^6.0.0",
-    "@vitest/coverage-v8": "^4.1.0",
-    "@vitest/coverage-istanbul": "^4.1.0",
-    "@microsoft/api-extractor": "^7.47.5",
-    "tsx": "^4.16.5",
-    "@types/js-yaml": "^4.0.9",
-    "js-yaml": "^4.1.0"
+    "prettier": "^3.8.1",
+    "vitest": "^4.1.3",
+    "vite": "^8.0.8",
+    "@vitest/coverage-v8": "^4.1.3",
+    "@microsoft/api-extractor": "^7.58.1",
+    "tsx": "^4.21.0",
+    "yaml": "^2.8.3",
+    "@typespec/tspd": "^0.75.0",
+    "@typespec/spec-api": "^0.1.0-alpha.14",
+    "@typespec/spector": "^0.1.0-alpha.25",
+    "@azure-tools/typespec-autorest": "^0.69.1",
+    "@azure-tools/azure-http-specs": "^0.1.0-alpha.42",
+    "@typespec/http-specs": "^0.1.0-alpha.38",
+    "@azure-tools/typespec-azure-core": "^0.69.0",
+    "@azure-tools/typespec-client-generator-core": "^0.69.0",
+    "@typespec/compiler": "^1.13.0",
+    "@typespec/openapi": "^1.13.0",
+    "@typespec/rest": "^0.83.0",
+    "@typespec/http": "^1.13.0",
+    "@typespec/versioning": "^0.83.0",
+    "@typespec/xml": "^0.83.0",
+    "@azure-tools/typespec-azure-resource-manager": "^0.69.1"
   },
   "peerDependencies": {
-    "@azure-tools/typespec-azure-core": "^0.68.0",
-    "@azure-tools/typespec-client-generator-core": "^0.68.3",
-    "@typespec/compiler": "^1.12.0",
-    "@typespec/http": "^1.12.0",
-    "@typespec/rest": "^0.82.0",
-    "@typespec/versioning": "^0.82.0",
-    "@typespec/xml": "^0.82.0"
+    "@azure-tools/typespec-azure-core": "^0.69.0",
+    "@typespec/compiler": "^1.13.0",
+    "@azure-tools/typespec-client-generator-core": "^0.69.0",
+    "@typespec/rest": "^0.83.0",
+    "@typespec/versioning": "^0.83.0",
+    "@typespec/http": "^1.13.0",
+    "@typespec/xml": "^0.83.0"
   },
   "dependencies": {
-    "fast-xml-parser": "^4.5.0",
-    "fs-extra": "^11.1.0",
+    "fast-xml-parser": "^5.7.0",
     "handlebars": "^4.7.7",
-    "lodash": "^4.17.21",
-    "prettier": "^3.3.3",
+    "prettier": "^3.8.1",
     "ts-morph": "^23.0.0",
     "tslib": "^2.3.1"
   },
@@ -89,10 +76,14 @@
     "LICENSE",
     "static/**"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Azure/typespec-azure.git"
+  },
   "bugs": {
-    "url": "https://github.com/Azure/autorest.typescript/issues"
+    "url": "https://github.com/Azure/typespec-azure/issues"
   },
-  "homepage": "https://github.com/Azure/autorest.typescript/tree/main/packages/typespec-ts/",
+  "homepage": "https://github.com/Azure/typespec-azure/tree/main/packages/typespec-ts/",
   "scripts": {
     "test-next": "vitest run --project test-next",
     "test-next:coverage": "vitest run --project test-next --coverage",
@@ -101,12 +92,10 @@
     "test": "npm run test-next && npm run unit-test && npm run integration-test-ci",
     "test:azure": "npm run test-next && npm run copy:typespec && npm run integration-test-ci:azure-rlc && npm run integration-test-ci:azure-modular",
     "test:standard": "npm run test-next && npm run copy:typespec && npm run unit-test&& npm run integration-test-ci:rlc && npm run integration-test-ci:modular",
-    "lint": "eslint src --ext .ts --max-warnings=0",
-    "lint:fix": "eslint src --fix --ext .ts",
-    "format": "npm run -s prettier -- --write",
-    "check-format": "npm run prettier -- --check",
-    "prettier": "prettier --config ./.prettierrc \"{src,test,static}/**/*.ts\" \"!test/**/generated/**/*.ts\"",
-    "check:tree": "node --loader ts-node/esm ./test/commands/check-clean-tree.ts",
+    "lint": "eslint . --ext .ts --max-warnings=0",
+    "lint:fix": "eslint . --fix --ext .ts",
+    "check:tree": "tsx ./test/commands/check-clean-tree.ts",
+    "test:ts:e2e": "npm run copy:typespec && npm run integration-test-ci:azure-rlc && npm run integration-test-ci:azure-modular",
     "integration-test-ci": "npm-run-all copy:typespec integration-test-ci:rlc integration-test-ci:azure-rlc integration-test-ci:modular integration-test-ci:azure-modular",
     "integration-test-ci:sequential": "npm-run-all --serial copy:typespec integration-test-ci:modular && npm run integration-test-ci:modular",
     "integration-test-ci:rlc": "npm-run-all --silent -p start-test-server:rlc --race generate-and-run:rlc",

package/src/context-manager.ts

@@ -0,0 +1,101 @@
+import { SdkContext } from "@azure-tools/typespec-client-generator-core";
+import { EmitContext } from "@typespec/compiler";
+import { Project, SourceFile } from "ts-morph";
+import { ExternalDependencies } from "./framework/dependency.js";
+import { Binder } from "./framework/hooks/binder.js";
+import { SdkTypeContext } from "./framework/hooks/sdk-types.js";
+import { RlcMetaTree } from "./meta-tree.js";
+
+/**
+ * Contexts Object Guidelines
+ * --------------------------
+ * The `Contexts` object contains various application-wide data that needs to be accessible across different parts of the program without the need to pass down props deeply.
+ *
+ * When to add a new context:
+ * - **Cross-Cutting Concerns**: Add a new context when the data or functionality is a cross-cutting concern used by multiple unrelated components or modules.
+ * - **Global State**: If the state needs to be globally accessible and mutable by different parts of the application, and does not belong to a specific component or module.
+ * - **Performance Optimization**: To avoid unnecessary compute or prop drilling that may lead to performance bottlenecks, especially when passing down props through many levels.
+ * - **Shared Resources**: For resources that are shared across various parts of the application, such as settings, configurations, or metadata.
+ *
+ * Remember, adding too many contexts can lead to complex dependencies and harder-to-maintain code. Always evaluate if the context is truly necessary or if there are better alternatives such as localized state management or passing props for simpler scenarios.
+ */
+type Contexts = {
+  rlcMetaTree: RlcMetaTree; // Context for RLC types metadata.
+  outputProject: Project; // The TS-Morph root project context for code generation.
+  symbolMap: Map<string, SourceFile>; // Mapping of symbols to their corresponding source files.
+  sdkTypes: SdkTypeContext;
+  emitContext: {
+    compilerContext: EmitContext;
+    tcgcContext: SdkContext;
+  };
+  binder: Binder;
+  dependencies: ExternalDependencies;
+};
+
+type ContextKey = keyof Contexts;
+
+/**
+ * Manages shared contexts across the application to minimize prop drilling and enhance modularity.
+ * Implements the Singleton pattern to ensure there is a single instance of ContextManager.
+ */
+class ContextManager {
+  private static instance: ContextManager;
+  private contexts: Map<ContextKey, any> = new Map();
+
+  private constructor() {}
+
+  /**
+   * Retrieves the singleton instance of the ContextManager.
+   * @returns {ContextManager} The singleton instance.
+   */
+  public static getInstance(): ContextManager {
+    if (!ContextManager.instance) {
+      ContextManager.instance = new ContextManager();
+    }
+    return ContextManager.instance;
+  }
+
+  /**
+   * Sets a value for a specific context key.
+   * @param {ContextKey} key - The key of the context to set.
+   * @param {Contexts[K]} value - The value to set for the specified context.
+   */
+  public setContext<K extends ContextKey>(key: K, value: Contexts[K]): void {
+    this.contexts.set(key, value);
+  }
+
+  /**
+   * Retrieves the context value for a specific key.
+   * @param {ContextKey} key - The key of the context to retrieve.
+   * @returns {Contexts[K] | undefined} The value of the context if found, otherwise undefined.
+   */
+  public getContext<K extends ContextKey>(key: K): Contexts[K] | undefined {
+    return this.contexts.get(key) as Contexts[K] | undefined;
+  }
+}
+
+// Expose the singleton instance of the context manager.
+export const contextManager = ContextManager.getInstance();
+
+/**
+ * A utility function to use a context by key.
+ * @param {ContextKey} key - The key of the context to retrieve.
+ * @throws Will throw an error if the context is not found.
+ * @returns {Contexts[K]} The context value.
+ */
+export function useContext<K extends ContextKey>(key: K): Contexts[K] {
+  const context = contextManager.getContext(key);
+  if (!context) {
+    throw new Error(`Context ${key} not found`);
+  }
+  return context;
+}
+
+/**
+ * Provides a context with a value to be accessible across the program.
+ * @param {ContextKey} key - The key of the context to provide.
+ * @param {Contexts[K]} value - The value to set for the specified context.
+ */
+export function provideContext<K extends ContextKey>(key: K, value: Contexts[K]): void {
+  contextManager.setContext(key, value);
+}

package/src/framework/declaration.ts

@@ -1,16 +1,16 @@
 import {
-  SourceFile,
+  ClassDeclaration,
   ClassDeclarationStructure,
+  EnumDeclaration,
   EnumDeclarationStructure,
+  FunctionDeclaration,
   FunctionDeclarationStructure,
+  InterfaceDeclaration,
   InterfaceDeclarationStructure,
-  TypeAliasDeclarationStructure,
+  SourceFile,
   StructureKind,
-  ClassDeclaration,
-  EnumDeclaration,
-  FunctionDeclaration,
-  InterfaceDeclaration,
-  TypeAliasDeclaration
+  TypeAliasDeclaration,
+  TypeAliasDeclarationStructure,
 } from "ts-morph";
 import { useBinder } from "./hooks/binder.js";
 import { refkey as getRefKey } from "./refkey.js";
@@ -31,58 +31,50 @@ export type Declarations =
 export function addDeclaration(
   sourceFile: SourceFile,
   declaration: ClassDeclarationStructure,
-  refkey: unknown
+  refkey: unknown,
 ): void;
 
 export function addDeclaration(
   sourceFile: SourceFile,
   declaration: EnumDeclarationStructure,
-  refkey: unknown
+  refkey: unknown,
 ): void;
 
 export function addDeclaration(
   sourceFile: SourceFile,
   declaration: FunctionDeclarationStructure,
-  refkey: unknown
+  refkey: unknown,
 ): void;
 
 export function addDeclaration(
   sourceFile: SourceFile,
   declaration: InterfaceDeclarationStructure,
-  refkey: unknown
+  refkey: unknown,
 ): void;
 
 export function addDeclaration(
   sourceFile: SourceFile,
   declaration: TypeAliasDeclarationStructure,
-  refkey: unknown
-): void;
-export function addDeclaration(
-  sourceFile: SourceFile,
-  declaration: string,
-  refkey: unknown
+  refkey: unknown,
 ): void;
+export function addDeclaration(sourceFile: SourceFile, declaration: string, refkey: unknown): void;
 export function addDeclaration(
   sourceFile: SourceFile,
   input: DeclarationStructures | string,
-  refkey: unknown
+  refkey: unknown,
 ): void {
   const binder = useBinder();
   const declaration: DeclarationStructures =
-    typeof input === "string"
-      ? ({ name: input, kind: StructureKind.TypeAlias } as any)
-      : input;
+    typeof input === "string" ? ({ name: input, kind: StructureKind.TypeAlias } as any) : input;
   if (!declaration.name) {
-    throw new Error(
-      `Declaration must have a name ${JSON.stringify(declaration)}`
-    );
+    throw new Error(`Declaration must have a name ${JSON.stringify(declaration)}`);
   }
 
   const stringRefkey = typeof refkey === "string" ? refkey : getRefKey(refkey);
   const trackedDeclarationName = binder.trackDeclaration(
     stringRefkey,
     declaration.name,
-    sourceFile
+    sourceFile,
   );
 
   // Update the declaration name to be unique
@@ -107,8 +99,6 @@ export function addDeclaration(
       }
       break;
     default:
-      throw new Error(
-        `Unsupported declaration kind ${(trackedDeclaration as any).kind}`
-      );
+      throw new Error(`Unsupported declaration kind ${(trackedDeclaration as any).kind}`);
   }
 }

package/src/framework/dependency.ts

@@ -5,8 +5,7 @@ export interface ReferenceableSymbol {
   visibility?: "internal" | "public";
 }
 
-export type ExternalDependencies = CoreDependencies &
-  Record<string, ReferenceableSymbol>;
+export type ExternalDependencies = CoreDependencies & Record<string, ReferenceableSymbol>;
 
 /**
  * This interface defines the well known Core dependencies that plugins can use to override and provide their own implementations if needed