Add support for Record<T> in tspd

microsoft · Oct 14, 2024 · d36cd77 · d36cd77
1 parent ab6d951
commit d36cd77
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/packages/tspd/src/gen-extern-signatures/decorators-signatures.ts b/packages/tspd/src/gen-extern-signatures/decorators-signatures.ts
@@ -222,6 +222,10 @@ export function generateSignatures(
         } else if (isReflectionType(type)) {
           return getValueOfReflectionType(type);
         } else {
+          // If its exactly the record type use Record<string, T> instead of the model name.
+          if (type.indexer && type.name === "Record" && type.namespace?.name === "TypeSpec") {
+            return `Record<string, ${getValueTSType(type.indexer.value)}>`;
+          }
           if (type.name) {
             return useLocalType(type);
           } else {
@@ -248,6 +252,9 @@ export function generateSignatures(
     const properties = [...model.properties.values()].map((x) => {
       return `readonly ${x.name}${x.optional ? "?" : ""}: ${getValueTSType(x.type)}`;
     });
+    if (model.indexer?.value) {
+      properties.unshift(`readonly [key: string]: ${getValueTSType(model.indexer.value)}`);
+    }
 
     return `{ ${properties.join(", ")} }`;
   }

diff --git a/packages/tspd/test/gen-extern-signature/decorators-signatures.test.ts b/packages/tspd/test/gen-extern-signature/decorators-signatures.test.ts
@@ -186,6 +186,11 @@ export type Decorators = {
       [`valueof "abc" | "def" | string`, `"abc" | "def" | string`],
       [`valueof string[]`, `readonly string[]`],
       [`valueof ("abc" | "def")[]`, `readonly ("abc" | "def")[]`],
+      [`valueof Record<int32>`, `Record<string, number>`],
+      [
+        `valueof {...Record<int32>, other: string}`,
+        `{ readonly [key: string]: number; readonly other: string }`,
+      ],
       [`valueof {name: string, age?: int32}`, `{ readonly name: string; readonly age?: number }`],
     ])("%s => %s", async (ref, expected) => {
       await expectSignatures({