@typespec/emitter-framework 0.8.0-dev.3 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog - @typespec/emitter-framework
 
+## 0.8.0
+
+### Features
+
+- [#7409](https://github.com/microsoft/typespec/pull/7409) Emit TypeSpec comments as JSDoc in TypeScript components
+
+### Bump dependencies
+
+- [#7605](https://github.com/microsoft/typespec/pull/7605) Updates alloy to 0.17
+
+### Bug Fixes
+
+- [#7369](https://github.com/microsoft/typespec/pull/7369) Render discriminated unions correctly
+
+
 ## 0.7.1
 
 ### Bump dependencies

package/dist/src/typescript/components/type-alias-declaration.js

@@ -27,7 +27,7 @@ export function TypeAliasDeclaration(props) {
     });
   }
   const doc = props.doc ?? $.type.getDoc(props.type);
-  const refkeys = declarationRefkeys(props.refkey, props.name);
+  const refkeys = declarationRefkeys(props.refkey, props.type);
   const name = ts.useTSNamePolicy().getName(originalName, "type");
   return _$createComponent(ts.TypeDeclaration, _$mergeProps({
     doc: doc

package/dist/src/typescript/components/type-declaration.js

@@ -11,7 +11,7 @@ export function TypeDeclaration(props) {
     $
   } = useTsp();
   if (!props.type) {
-    const refkeys = declarationRefkeys(props.refkey, props.name);
+    const refkeys = declarationRefkeys(props.refkey, props.type);
     return _$createComponent(ts.TypeDeclaration, _$mergeProps(props, {
       refkey: refkeys
     }));

package/dist/src/typescript/utils/operation.d.ts

@@ -1,3 +1,4 @@
+import { Refkey } from "@alloy-js/core";
 import * as ts from "@alloy-js/typescript";
 import { Model, ModelProperty, Operation, Type } from "@typespec/compiler";
 export declare function getReturnType(type: Operation, options?: {
@@ -6,7 +7,8 @@ export declare function getReturnType(type: Operation, options?: {
 export interface BuildParameterDescriptorsOptions {
     params?: ts.ParameterDescriptor[] | string[] | undefined;
     mode?: "prepend" | "append" | "replace";
+    suffixRefkey?: Refkey;
 }
 export declare function buildParameterDescriptors(type: Model, options?: BuildParameterDescriptorsOptions): ts.ParameterDescriptor[] | undefined;
-export declare function buildParameterDescriptor(modelProperty: ModelProperty): ts.ParameterDescriptor;
+export declare function buildParameterDescriptor(modelProperty: ModelProperty, suffixRefkey: Refkey): ts.ParameterDescriptor;
 //# sourceMappingURL=operation.d.ts.map

package/dist/src/typescript/utils/operation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../../src/typescript/utils/operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAK3E,wBAAgB,aAAa,CAC3B,IAAI,EAAE,SAAS,EACf,OAAO,GAAE;IAAE,kBAAkB,EAAE,OAAO,CAAA;CAAkC,GACvE,IAAI,CASN;AAED,MAAM,WAAW,gCAAgC;IAC/C,MAAM,CAAC,EAAE,EAAE,CAAC,mBAAmB,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;IACzD,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;CACzC;AAED,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,KAAK,EACX,OAAO,GAAE,gCAAqC,GAC7C,EAAE,CAAC,mBAAmB,EAAE,GAAG,SAAS,CAkBtC;AAED,wBAAgB,wBAAwB,CAAC,aAAa,EAAE,aAAa,GAAG,EAAE,CAAC,mBAAmB,CAa7F"}
+{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../../src/typescript/utils/operation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAK3E,wBAAgB,aAAa,CAC3B,IAAI,EAAE,SAAS,EACf,OAAO,GAAE;IAAE,kBAAkB,EAAE,OAAO,CAAA;CAAkC,GACvE,IAAI,CASN;AAED,MAAM,WAAW,gCAAgC;IAC/C,MAAM,CAAC,EAAE,EAAE,CAAC,mBAAmB,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;IACzD,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,KAAK,EACX,OAAO,GAAE,gCAAqC,GAC7C,EAAE,CAAC,mBAAmB,EAAE,GAAG,SAAS,CAqBtC;AAED,wBAAgB,wBAAwB,CACtC,aAAa,EAAE,aAAa,EAC5B,YAAY,EAAE,MAAM,GACnB,EAAE,CAAC,mBAAmB,CAaxB"}

package/dist/src/typescript/utils/operation.js

@@ -1,3 +1,4 @@
+import { refkey } from "@alloy-js/core";
 import * as ts from "@alloy-js/typescript";
 import { useTsp } from "../../core/index.js";
 import { TypeExpression } from "../components/type-expression.js";
@@ -18,18 +19,19 @@ export function buildParameterDescriptors(type, options = {}) {
   const {
     $
   } = useTsp();
+  const suffixRefkey = options.suffixRefkey ?? refkey();
   const optionsParams = normalizeParameters(options.params);
   if (options.mode === "replace") {
     return optionsParams;
   }
   const modelProperties = $.model.getProperties(type);
-  const operationParams = [...modelProperties.values()].map(buildParameterDescriptor);
+  const operationParams = [...modelProperties.values()].map(m => buildParameterDescriptor(m, suffixRefkey));
 
   // Merge parameters based on location
   const allParams = options.mode === "append" ? operationParams.concat(optionsParams) : optionsParams.concat(operationParams);
   return allParams;
 }
-export function buildParameterDescriptor(modelProperty) {
+export function buildParameterDescriptor(modelProperty, suffixRefkey) {
   const {
     $
   } = useTsp();
@@ -40,7 +42,7 @@ export function buildParameterDescriptor(modelProperty) {
   return {
     doc,
     name: paramName,
-    refkey: efRefkey(modelProperty),
+    refkey: efRefkey(modelProperty, suffixRefkey),
     optional: isOptional,
     type: TypeExpression({
       type: modelProperty.type

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/emitter-framework",
-  "version": "0.8.0-dev.3",
+  "version": "0.8.0",
   "type": "module",
   "main": "dist/index.js",
   "exports": {
@@ -19,21 +19,18 @@
   "license": "MIT",
   "description": "",
   "peerDependencies": {
-    "@alloy-js/core": "^0.16.0",
-    "@alloy-js/typescript": "^0.16.0",
-    "@typespec/compiler": "^1.0.0",
-    "@typespec/http": "^1.0.1",
-    "@typespec/rest": "^0.70.0 || >=0.71.0-dev <0.71.0"
+    "@alloy-js/core": "^0.17.0",
+    "@alloy-js/typescript": "^0.17.0",
+    "@typespec/compiler": "^1.1.0",
+    "@typespec/http": "^1.1.0",
+    "@typespec/rest": "^0.71.0"
   },
   "devDependencies": {
-    "@alloy-js/cli": "^0.16.0",
+    "@alloy-js/cli": "^0.17.0",
     "@alloy-js/rollup-plugin": "^0.1.0",
-    "@alloy-js/core": "^0.16.0",
-    "@alloy-js/typescript": "^0.16.0",
+    "@alloy-js/core": "^0.17.0",
+    "@alloy-js/typescript": "^0.17.0",
     "@types/minimist": "^1.2.5",
-    "@typespec/compiler": "^1.0.0",
-    "@typespec/http": "^1.0.1",
-    "@typespec/rest": "^0.70.0 || >=0.71.0-dev <0.71.0",
     "concurrently": "^9.1.2",
     "minimist": "^1.2.8",
     "prettier": "~3.5.3",
@@ -44,9 +41,11 @@
     "tree-sitter-python": "^0.23.2",
     "tree-sitter-typescript": "^0.23.0",
     "typescript": "~5.8.2",
-    "vitest": "^3.1.2"
+    "vitest": "^3.1.2",
+    "@typespec/compiler": "^1.1.0",
+    "@typespec/http": "^1.1.0",
+    "@typespec/rest": "^0.71.0"
   },
-  "dependencies": {},
   "scripts": {
     "build": "alloy build",
     "clean": "rimraf ./dist",

package/src/typescript/components/type-alias-declaration.tsx

@@ -31,7 +31,7 @@ export function TypeAliasDeclaration(props: TypeAliasDeclarationProps) {
   }
 
   const doc = props.doc ?? $.type.getDoc(props.type);
-  const refkeys = declarationRefkeys(props.refkey, props.name);
+  const refkeys = declarationRefkeys(props.refkey, props.type);
 
   const name = ts.useTSNamePolicy().getName(originalName, "type");
   return (

package/src/typescript/components/type-declaration.tsx

@@ -17,7 +17,7 @@ export type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] };
 export function TypeDeclaration(props: TypeDeclarationProps) {
   const { $ } = useTsp();
   if (!props.type) {
-    const refkeys = declarationRefkeys(props.refkey, props.name);
+    const refkeys = declarationRefkeys(props.refkey, props.type);
     return (
       <ts.TypeDeclaration
         {...(props as WithRequired<ts.TypeDeclarationProps, "name">)}

package/src/typescript/utils/operation.ts

@@ -1,3 +1,4 @@
+import { refkey, Refkey } from "@alloy-js/core";
 import * as ts from "@alloy-js/typescript";
 import { Model, ModelProperty, Operation, Type } from "@typespec/compiler";
 import { useTsp } from "../../core/index.js";
@@ -21,6 +22,7 @@ export function getReturnType(
 export interface BuildParameterDescriptorsOptions {
   params?: ts.ParameterDescriptor[] | string[] | undefined;
   mode?: "prepend" | "append" | "replace";
+  suffixRefkey?: Refkey;
 }
 
 export function buildParameterDescriptors(
@@ -28,6 +30,7 @@ export function buildParameterDescriptors(
   options: BuildParameterDescriptorsOptions = {},
 ): ts.ParameterDescriptor[] | undefined {
   const { $ } = useTsp();
+  const suffixRefkey = options.suffixRefkey ?? refkey();
   const optionsParams = normalizeParameters(options.params);
 
   if (options.mode === "replace") {
@@ -35,7 +38,9 @@ export function buildParameterDescriptors(
   }
 
   const modelProperties = $.model.getProperties(type);
-  const operationParams = [...modelProperties.values()].map(buildParameterDescriptor);
+  const operationParams = [...modelProperties.values()].map((m) =>
+    buildParameterDescriptor(m, suffixRefkey),
+  );
 
   // Merge parameters based on location
   const allParams =
@@ -46,7 +51,10 @@ export function buildParameterDescriptors(
   return allParams;
 }
 
-export function buildParameterDescriptor(modelProperty: ModelProperty): ts.ParameterDescriptor {
+export function buildParameterDescriptor(
+  modelProperty: ModelProperty,
+  suffixRefkey: Refkey,
+): ts.ParameterDescriptor {
   const { $ } = useTsp();
   const namePolicy = ts.useTSNamePolicy();
   const paramName = namePolicy.getName(modelProperty.name, "parameter");
@@ -55,7 +63,7 @@ export function buildParameterDescriptor(modelProperty: ModelProperty): ts.Param
   return {
     doc,
     name: paramName,
-    refkey: efRefkey(modelProperty),
+    refkey: efRefkey(modelProperty, suffixRefkey),
     optional: isOptional,
     type: TypeExpression({ type: modelProperty.type }),
   };