refactor: refactor types

Author: robert-hebel-sb

package-lock.json

@@ -146,8 +146,6 @@
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.3.0",
     "@testing-library/user-event": "^14.6.1",
-    "@types/lodash": "^4.17.17",
-    "@types/swagger-ui-react": "^5.18.0",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "copyfiles": "^2.4.1",

package.json

@@ -1,6 +1,14 @@
+import { Action } from 'types/actions';
+
 export const EDITOR_PROP_CHANGED = 'EDITOR_PROP_CHANGED';
 
-export const propChanged = (propName: string, newValue: unknown, oldValue: unknown) => ({
+export type PropChangedAction = (
+  propName: string,
+  newValue: unknown,
+  oldValue: unknown
+) => Action<string, { newValue: unknown; oldValue: unknown }>;
+
+export const propChanged: PropChangedAction = (propName, newValue, oldValue) => ({
   type: EDITOR_PROP_CHANGED,
   payload: propName,
   meta: { newValue, oldValue },

src/plugins/props-change-watcher/actions.ts

@@ -1,10 +1,10 @@
 import { useRef } from 'react';
-import { GetSystemValues, System } from 'types/system';
+import { SystemValues, System } from 'types/system';
 
 import pluginImpl from '../plugin-impl';
 
 const useMountPlugin = () => {
-  const system = useRef<null | GetSystemValues>(null);
+  const system = useRef<null | SystemValues>(null);
 
   return {
     plugin(sys: System) {

src/plugins/props-change-watcher/hooks/use-mount-plugin.ts

@@ -2,7 +2,7 @@ import { useEffect, useRef } from 'react';
 
 type UsePropChangeCallback = (newValue: unknown, oldValue: unknown) => void;
 
-const usePropChange = (prop: string | object | undefined, callback: UsePropChangeCallback) => {
+const usePropChange = (prop: unknown, callback: UsePropChangeCallback) => {
   const isInitialMount = useRef(true);
   const previousProp = useRef(prop);
 

src/plugins/props-change-watcher/hooks/use-prop-change.ts

@@ -0,0 +1,13 @@
+export type AnyAction<T extends string = string> = {
+  type: T;
+};
+
+export interface Action<
+  Payload,
+  Meta extends Record<string, unknown> | unknown[] | undefined = undefined,
+> extends AnyAction {
+  type: string;
+  payload: Payload;
+  error?: boolean;
+  meta?: Meta;
+}

src/types/actions.ts

@@ -7,9 +7,9 @@ declare module 'swagger-ui-react' {
   }
   type System = unknown;
 
-  type PluginGenerator = (system: System) => object;
+  export type PluginGenerator = (system: System) => object;
 
-  type Plugin = object | PluginGenerator;
+  export type Plugin = object | PluginGenerator;
 
   export type Preset = () => unknown;
 

src/types/index.d.ts

@@ -1,10 +1,5 @@
 import React from 'react';
-import { Preset, SwaggerUIProps } from 'swagger-ui-react';
-import { System } from 'types/system';
-
-type PluginGenerator = (system: System) => object;
-
-type Plugin = object | PluginGenerator;
+import { Preset, SwaggerUIProps, Plugin } from 'swagger-ui-react';
 
 enum presetNames {
   textarea = 'textarea',

src/types/swagger-editor.ts

@@ -1,19 +1,22 @@
-export interface GetSystemValues {
+import { PropChangedAction } from 'plugins/props-change-watcher/actions';
+import { Action } from 'types/actions';
+
+export interface SystemValues {
   getComponent: () => void;
   editorSelectors: {
-    selectContent: () => unknown;
-    selectInferFileNameWithExtensionFromContent: () => unknown;
+    selectContent: () => string;
+    selectInferFileNameWithExtensionFromContent: () => string;
   };
   editorActions: {
-    convertContentToJSON: () => void;
-    setContent: (content: unknown) => void;
-    propChanged: (spec: string, oldValue: unknown, newValue: unknown) => void;
+    convertContentToJSON: (content: string) => Action<string>;
+    setContent: (content: string) => Action<string>;
+    propChanged: PropChangedAction;
   };
   EditorContentOrigin: {
-    Conversion: string;
+    Conversion: 'conversion';
   };
 }
 
-export interface System {
-  getSystem: () => GetSystemValues;
+export interface System extends SystemValues {
+  getSystem: () => SystemValues;
 }