Restructuring extension local types

Author: stricklandrbls

src/dataEditor/dataEditorClient.ts

@@ -64,18 +64,18 @@ import path from 'path'
 import * as vscode from 'vscode'
 import XDGAppPaths from 'xdg-app-paths'
 import { extractDaffodilEvent } from '../daffodilDebugger/daffodil'
+import { VIEWPORT_CAPACITY_MAX } from '../svelte/src/stores/configuration'
 import {
-  EditByteModes,
-  VIEWPORT_CAPACITY_MAX,
-} from '../svelte/src/stores/configuration'
-import {
-  EditorMessage,
   MessageCommand,
-  MessageLevel,
-} from '../svelte/src/utilities/message'
+  EditByteModes,
+  ExtensionMessageResponses,
+} from 'ext_types'
 import * as editor_config from './config'
 import { configureOmegaEditPort, ServerInfo } from './include/server/ServerInfo'
-import { SvelteWebviewInitializer } from './svelteWebviewInitializer'
+import {
+  SvelteUIWebviewPanel,
+  SvelteWebviewInitializer,
+} from './svelteWebviewInitializer'
 import {
   addActiveSession,
   removeActiveSession,
@@ -131,7 +131,7 @@ export function activate(ctx: vscode.ExtensionContext): void {
 // *****************************************************************************
 
 export class DataEditorClient implements vscode.Disposable {
-  public panel: vscode.WebviewPanel
+  public panel: SvelteUIWebviewPanel
   private svelteWebviewInitializer: SvelteWebviewInitializer
   private displayState: DisplayState
   private currentViewportId: string
@@ -149,7 +149,7 @@ export class DataEditorClient implements vscode.Disposable {
     fileToEdit: string = '',
     panel: vscode.WebviewPanel
   ) {
-    this.panel = panel
+    this.panel = new SvelteUIWebviewPanel(panel)
     this.panel.webview.onDidReceiveMessage(this.messageReceiver, this)
 
     this.disposables = [

src/dataEditor/svelteWebviewInitializer.ts

@@ -17,6 +17,30 @@
 
 import * as vscode from 'vscode'
 import * as fs from 'fs'
+import {
+  DataEditorMessageRequests,
+  DataEditorMessageResponses,
+  ExtensionMessageRequests,
+  ExtensionMessageResponses,
+} from 'ext_types'
+
+export class SvelteUIWebviewPanel {
+  constructor(private vscodePanel: vscode.WebviewPanel) {}
+  postEditorResponse<K extends keyof DataEditorMessageResponses>(
+    type: K,
+    message: DataEditorMessageResponses[K]
+  ) {
+    this.vscodePanel.webview.postMessage({ command: type, data: message })
+  }
+  postExtensionResponse<K extends keyof ExtensionMessageResponses>(
+    type: K,
+    message: ExtensionMessageResponses[K]
+  ) {
+    this.vscodePanel.webview.postMessage({ command: type, data: message })
+  }
+  onDidReceive
+}
+
 export class SvelteWebviewInitializer {
   constructor(private context: vscode.ExtensionContext) {}
 

src/ext_types/dom.ts

@@ -0,0 +1,16 @@
+import { ExtensionMessages } from 'ext_types'
+
+interface DataEditorDOMInterface {
+  addMessageListener: <K extends keyof ExtensionMessages>(
+    type: K,
+    listener: (response: any) => void
+  ) => void
+}
+
+declare global {
+  interface Window {
+    dataeditor: DataEditorDOMInterface
+  }
+}
+
+export {}

src/svelte/src/utilities/message.ts src/ext_types/formattypes.tssrc/svelte/src/utilities/message.ts renamed to src/ext_types/formattypes.ts

@@ -15,37 +15,27 @@
  * limitations under the License.
  */
 
-export enum MessageCommand {
-  clearChanges,
-  applyChanges,
-  editorOnChange,
-  fileInfo,
-  heartbeat,
-  profile,
-  redoChange,
-  replaceResults,
-  requestEditedData,
-  save,
-  saveAs,
-  saveSegment,
-  scrollViewport,
-  search,
-  replace,
-  searchResults,
-  setUITheme,
-  showMessage,
-  undoChange,
-  updateLogicalDisplay,
-  viewportRefresh,
-}
+export type Radixes = 'Hexadecimal' | 'Decimal' | 'Octal' | 'Binary'
+
+export type RadixValues = 16 | 10 | 8 | 2
 
-export enum MessageLevel {
-  Error,
-  Info,
-  Warn,
+export type BytesPerRow = 16 | 8 | 24
+
+export enum EditByteModes {
+  Single = 'single',
+  Multiple = 'multiple',
 }
+export type AvailableStrEncodings =
+  | 'hex'
+  | 'binary'
+  | 'ascii'
+  | 'latin1'
+  | 'utf-8'
+  | 'utf-16'
 
-export type EditorMessage = {
-  command: MessageCommand
-  data: Record<string, any>
+export enum EditActionRestrictions {
+  None,
+  OverwriteOnly,
 }
+
+export type EditAction = { name: string; value: EditActionRestrictions }

src/ext_types/index.ts

@@ -0,0 +1,3 @@
+export * from './formattypes'
+export * from './messageContent'
+export * from './messages'

src/ext_types/messageContent.ts

@@ -0,0 +1,126 @@
+import { EditByteModes } from 'ext_types'
+import {
+  ApplyChangesRequest,
+  ChangesInfoResponse,
+  CountResponse,
+  EditedDataRequest,
+  EditedDataResponse,
+  EditorOnChangeRequest,
+  EditorOnChangeResponse,
+  FileInfoResponse,
+  NotificationRequest,
+  ProfileRequest,
+  ProfileResponse,
+  ReplaceRequest,
+  ReplaceResponse,
+  SaveAsResponse,
+  SaveRequest,
+  SaveSegmentRequest,
+  ScrollViewportRequest,
+  SearchRequest,
+  SearchResponse,
+  SetUIThemeRequest,
+  UndoRequest,
+  ViewportRefreshResponse,
+} from './messages'
+
+export enum MessageCommand {
+  clearChanges,
+  applyChanges,
+  editorOnChange,
+  fileInfo,
+  heartbeat,
+  profile,
+  redoChange,
+  replaceResults,
+  requestEditedData,
+  save,
+  saveAs,
+  saveSegment,
+  scrollViewport,
+  search,
+  replace,
+  searchResults,
+  setUITheme,
+  showMessage,
+  undoChange,
+  updateLogicalDisplay,
+  viewportRefresh,
+}
+export type ExtensionMessageCommands =
+  | 'clearChanges'
+  | 'applyChanges'
+  | 'editorOnChange'
+  | 'fileInfo'
+  | 'heartbeat'
+  | 'profile'
+  | 'redoChange'
+  | 'replaceResults'
+  | 'requestEditedData'
+  | 'save'
+  | 'saveAs'
+  | 'saveSegment'
+  | 'scrollViewport'
+  | 'search'
+  | 'replace'
+  | 'searchResults'
+  | 'setUITheme'
+  | 'showMessage'
+  | 'undoChange'
+  | 'updateLogicalDisplay'
+  | 'viewportRefresh'
+
+/**
+ * Key indexable interface to templated type inference of available messages sent between
+ * the components of the DFDL VSCode extension.
+ */
+export interface DataEditorMessageRequests {
+  counts: never
+  clearChanges: never
+  applyChanges: ApplyChangesRequest
+  editorOnChange: EditorOnChangeRequest
+  fileInfo: never // service
+  heartbeat: never // service
+  profile: ProfileRequest // service
+  redoChange: never
+  replaceResults: never
+  requestEditedData: EditedDataRequest
+  save: SaveRequest
+  saveAs: SaveRequest
+  saveSegment: SaveSegmentRequest
+  scrollViewport: ScrollViewportRequest
+  search: SearchRequest
+  replace: ReplaceRequest
+  undoChange: UndoRequest
+  viewportRefresh: never
+}
+export interface ExtensionMessageRequests {
+  showMessage: NotificationRequest
+  setUITheme: SetUIThemeRequest
+}
+
+export interface ExtensionMessageResponses {
+  showMessage: undefined
+  setUITheme: void
+}
+
+export interface DataEditorMessageResponses {
+  clearChanges: void
+  applyChanges: ChangesInfoResponse
+  editorOnChange: EditorOnChangeResponse
+  fileInfo: FileInfoResponse
+  counts: CountResponse
+  // heartbeat: IServerHeartbeat & { port: number } // service
+  profile: ProfileResponse
+  redoChange: void
+  replaceResults: ReplaceResponse
+  requestEditedData: EditedDataResponse
+  save: void
+  saveAs: SaveAsResponse
+  saveSegment: void
+  scrollViewport: void
+  search: SearchResponse
+  replace: ReplaceResponse
+  undoChange: void
+  viewportRefresh: ViewportRefreshResponse
+}