Adds public function for setting info object directly

.chronus/changes/irvine-set-info-extension-2024-6-3-0-48-13.md

@@ -0,0 +1,7 @@
+---
+changeKind: feature
+packages:
+  - "@typespec/openapi"
+---
+
+Adds support for extending namespace with extensions

packages/openapi/src/decorators.ts

@@ -54,7 +54,7 @@ export const $extension: ExtensionDecorator = (
   extensionName: string,
   value: TypeSpecValue
 ) => {
-  if (!isOpenAPIExtensionKey(extensionName)) {
+  if (entity.kind !== "Namespace" && !isOpenAPIExtensionKey(extensionName)) {
     reportDiagnostic(context.program, {
       code: "invalid-extension-key",
       format: { value: extensionName },
@@ -66,13 +66,18 @@ export const $extension: ExtensionDecorator = (
   if (diagnostics.length > 0) {
     context.program.reportDiagnostics(diagnostics);
   }
-  setExtension(context.program, entity, extensionName as ExtensionKey, data);
+
+  if (entity.kind === "Namespace") {
+    setExtension(context.program, entity, extensionName, data);
+  } else {
+    setExtension(context.program, entity, extensionName as ExtensionKey, data);
+  }
 };
 
 export function setExtension(
   program: Program,
   entity: Type,
-  extensionName: ExtensionKey,
+  extensionName: ExtensionKey | string,
   data: unknown
 ) {
   const openApiExtensions = program.stateMap(openApiExtensionKey);
@@ -86,6 +91,19 @@ export function getExtensions(program: Program, entity: Type): ReadonlyMap<Exten
   return program.stateMap(openApiExtensionKey).get(entity) ?? new Map<ExtensionKey, any>();
 }
 
+/**
+ * Gets the extensions for a namespace.
+ * @param program global program
+ * @param entity the namespace
+ * @returns the extensions for the entity
+ */
+export function getNamespaceExtensions(
+  program: Program,
+  entity: Namespace
+): ReadonlyMap<string, any> {
+  return program.stateMap(openApiExtensionKey).get(entity) ?? new Map<string, any>();
+}
+
 function isOpenAPIExtensionKey(key: string): key is ExtensionKey {
   return key.startsWith("x-");
 }
@@ -159,9 +177,23 @@ export const $info: InfoDecorator = (
   }
   context.program.stateMap(infoKey).set(entity, data);
 };
-
+/** The extension name to be used to extend `@info`. */
+export const infoExtensionName = "infoExtension";
 export function getInfo(program: Program, entity: Namespace): AdditionalInfo | undefined {
-  return program.stateMap(infoKey).get(entity);
+  const info = program.stateMap(infoKey).get(entity);
+  const extensionsMap = getNamespaceExtensions(program, entity);
+  const extensions = extensionsMap.get(infoExtensionName);
+
+  /* The following info properties can be provided via extensions and should be overridden */
+  if (extensions && info) {
+    if (Object.prototype.hasOwnProperty.call(extensions, "contact")) {
+      info.contact = null;
+    }
+    if (Object.prototype.hasOwnProperty.call(extensions, "title")) {
+      info.title = null;
+    }
+  }
+  return omitUndefined({ ...info, ...extensions });
 }
 
 /** Resolve the info entry by merging data specified with `@service`, `@summary` and `@info`. */

packages/openapi/test/decorators.test.ts

@@ -53,6 +53,35 @@ describe("openapi: decorators", () => {
       });
     });
 
+    it("apply extension on namespace", async () => {
+      const { Service } = (await runner.compile(`
+        alias sample = {
+          "contact": {
+            "email": "ionutro@microsoft.com",
+          },
+          "title": "Sample Title",
+          "x-ai-description": "Sample description.",
+          "x-legal-info-url": "https://app.sample.ai/legal",
+          "x-logo": "https://th.bing.com/th?id=OSK.935650835684F7E18AC3F31034DE6DF3",
+          "x-privacy-policy-url": "https://app.sample.ai/privacy",      
+        };        
+        @extension("infoExtension", sample)
+        @test namespace Service {}
+      `)) as { Service: Namespace };
+
+      const info = getInfo(runner.program, Service);
+      deepStrictEqual(info, {
+        contact: {
+          email: "ionutro@microsoft.com",
+        },
+        title: "Sample Title",
+        "x-ai-description": "Sample description.",
+        "x-legal-info-url": "https://app.sample.ai/legal",
+        "x-logo": "https://th.bing.com/th?id=OSK.935650835684F7E18AC3F31034DE6DF3",
+        "x-privacy-policy-url": "https://app.sample.ai/privacy",
+      });
+    });
+
     it("apply extension with complex value", async () => {
       const { Foo } = await runner.compile(`
         @extension("x-custom", {foo: 123, bar: "string"})
@@ -67,7 +96,7 @@ describe("openapi: decorators", () => {
       });
     });
 
-    it("emit diagnostics when passing non string extension key", async () => {
+    it("emit diagnostics when passing non string extension key on a non-namespace", async () => {
       const diagnostics = await runner.diagnose(`
         @extension(123, "Bar")
         @test
@@ -81,7 +110,7 @@ describe("openapi: decorators", () => {
       });
     });
 
-    it("emit diagnostics when passing extension key not starting with `x-`", async () => {
+    it("emit diagnostics when passing extension key not starting with `x-` on a non-namespace", async () => {
       const diagnostics = await runner.diagnose(`
         @extension("foo", "Bar")
         @test