Update for new NotebookCellOutput changes (#35)

* update renderer types def * code changes for new API * support both types in error message Co-authored-by: Ian Huff <ianhuff@MININT-ST2TT53.redmond.corp.microsoft.com>

Author: IanMatthewHuff

package-lock.json

@@ -122,7 +122,7 @@
  "@types/react-dom": "^16.9.8",
  "@types/uuid": "^8.0.0",
  "@types/vscode": "^1.45.0",
- "@types/vscode-notebook-renderer": "^1.48.0",
+ "@types/vscode-notebook-renderer": "^1.55.0",
  "@typescript-eslint/eslint-plugin": "^3.1.0",
  "@typescript-eslint/parser": "^3.1.0",
  "cache-loader": "^4.1.0",

package.json

@@ -24,59 +24,80 @@ const notebookApi = acquireNotebookRendererApi(JupyterNotebookRenderer);
 
 notebookApi.onDidCreateOutput(renderOutput);
 
+// Copy of vscode-notebook-renderer old types as of 1.48
+// Keep these so we can support both the old interface and the new interface
+// Interface change here: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/51675/files
+interface OldNotebookCellOutputMetadata {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ custom?: { [key: string]: any };
+}
+interface OldNotebookOutput {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ data: { [mimeType: string]: any };
+ metadata?: OldNotebookCellOutputMetadata;
+}
+interface OldNotebookOutputEventParams {
+ element: HTMLElement;
+ outputId: string;
+ output: OldNotebookOutput;
+ mimeType: string;
+}
+
 /**
  * Called from renderer to render output.
  * This will be exposed as a public method on window for renderer to render output.
  */
 function renderOutput(request: NotebookOutputEventParams) {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ const mimeString = request.mime || (request as any).mimeType;
  try {
- console.error('request', request);
+ console.log('request', request);
  const output = convertVSCodeOutputToExecutResultOrDisplayData(request);
- console.log(`Rendering mimeType ${request.mimeType}`, output);
- console.error('request output', output);
+ console.log(`Rendering mimeType ${mimeString}`, output);
+ console.log('request output', output);
 
- ReactDOM.render(React.createElement(CellOutput, { mimeType: request.mimeType, output }, null), request.element);
+ ReactDOM.render(React.createElement(CellOutput, { mimeType: mimeString, output }, null), request.element);
  } catch (ex) {
- console.error(`Failed to render mime type ${request.mimeType}`, ex);
+ console.error(`Failed to render mime type ${mimeString}`, ex);
  }
 }
 
 function convertVSCodeOutputToExecutResultOrDisplayData(
  request: NotebookOutputEventParams
 ): nbformat.IExecuteResult | nbformat.IDisplayData {
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- const metadata: Record<string, any> = {};
- // Send metadata only for the mimeType we are interested in.
- const customMetadata = request.output.metadata?.custom;
- if (customMetadata) {
- // Support for Old API
- if (customMetadata[request.mimeType]) {
- metadata[request.mimeType] = customMetadata[request.mimeType];
- }
- if (customMetadata.needs_background) {
- metadata.needs_background = customMetadata.needs_background;
- }
- if (customMetadata.unconfined) {
- metadata.unconfined = customMetadata.unconfined;
- }
+ if ('mime' in request) {
+ // New API
+ return {
+ data: {
+ [request.mime]: request.value
+ },
+ metadata: request.metadata || {},
+ execution_count: null,
+ output_type: request.metadata?.outputType || 'execute_result'
+ };
  } else {
- // New API.
+ // Old API
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
- const outputMetadata = request.output.metadata as Record<string, any> | undefined;
- if (outputMetadata && outputMetadata[request.mimeType] && outputMetadata[request.mimeType].metadata) {
+ const metadata: Record<string, any> = {};
+
+ const oldRequest = (request as unknown) as OldNotebookOutputEventParams;
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ const outputMetadata = oldRequest.output.metadata as Record<string, any> | undefined;
+ if (outputMetadata && outputMetadata[oldRequest.mimeType] && outputMetadata[oldRequest.mimeType].metadata) {
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
- Object.assign(metadata, outputMetadata[request.mimeType].metadata);
- if (request.mimeType in outputMetadata[request.mimeType].metadata) {
- Object.assign(metadata, outputMetadata[request.mimeType].metadata[request.mimeType]);
+ Object.assign(metadata, outputMetadata[oldRequest.mimeType].metadata);
+ if (oldRequest.mimeType in outputMetadata[oldRequest.mimeType].metadata) {
+ Object.assign(metadata, outputMetadata[oldRequest.mimeType].metadata[oldRequest.mimeType]);
  }
  }
+
+ return {
+ data: {
+ [oldRequest.mimeType]: oldRequest.output.data[oldRequest.mimeType]
+ },
+ metadata,
+ execution_count: null,
+ output_type: oldRequest.output.metadata?.custom?.vscode?.outputType || 'execute_result'
+ };
  }
- return {
- data: {
- [request.mimeType]: request.output.data[request.mimeType]
- },
- metadata,
- execution_count: null,
- output_type: request.output.metadata?.custom?.vscode?.outputType || 'execute_result'
- };
 }