Enhance streamUI to Include providerMetadata in Final Stream for Improved Access to Additional Information

packages/ai/rsc/stream-ui/stream-ui.tsx

@@ -68,6 +68,15 @@ type RenderText = Renderer<
        * If `true`, the `content` will be the final output and this call will be the last.
        */
       done: boolean;
+
+       /**
+         * The provider metadata.
+         */
+       providerMetadata: ProviderMetadata<{
+        perplexity: {
+          citations: string[]
+        }
+      }>;
     },
   ]
 >;
@@ -206,6 +215,11 @@ functionality that can be fully encapsulated in the provider.
     rawResponse?: {
       headers?: Record<string, string>;
     };
+    providerMetadata: ProviderMetadata<{
+      perplexity: {
+        citations: string[]
+      }
+    }>;
   } | null = null;
 
   async function render({
@@ -370,6 +384,7 @@ functionality that can be fully encapsulated in the provider.
               usage: calculateLanguageModelUsage(value.usage),
               warnings: result.warnings,
               rawResponse: result.rawResponse,
+              providerMetadata: result.providerMetadata,
             };
             break;
           }
@@ -379,7 +394,7 @@ functionality that can be fully encapsulated in the provider.
       if (!hasToolCall) {
         render({
           renderer: textRender,
-          args: [{ content, done: true }],
+          args: [{ content, done: true, providerMetadata: finishEvent?.providerMetadata || {} }],
           streamableUI: ui,
           isLastCall: true,
         });