fix(engine-core): export wire types used in WireAdapter (salesforce#1951)

jodarove · web-flow · commit 816f06b1835a · 2020-06-26T12:13:40.000-07:00
diff --git a/packages/@lwc/engine-core/src/framework/main.ts b/packages/@lwc/engine-core/src/framework/main.ts
@@ -39,4 +39,11 @@ export { getComponentDef, isComponentConstructor } from './def';
 
 // Types -------------------------------------------------------------------------------------------
 export type { Renderer } from './renderer';
-export type { DataCallback, WireAdapter, WireAdapterConstructor } from './wiring';
+export type {
+    ConfigValue as WireConfigValue,
+    ContextValue as WireContextValue,
+    DataCallback,
+    WireAdapter,
+    WireAdapterConstructor,
+    WireAdapterSchemaValue,
+} from './wiring';
diff --git a/packages/@lwc/engine-core/src/framework/wiring.ts b/packages/@lwc/engine-core/src/framework/wiring.ts
@@ -217,15 +217,15 @@ function createConnector(vm: VM, name: string, wireDef: WireDef): WireAdapter {
 }
 
 export type DataCallback = (value: any) => void;
-type ConfigValue = Record<string, any>;
+export type ConfigValue = Record<string, any>;
 
 export interface WireAdapter {
     update(config: ConfigValue, context?: ContextValue): void;
     connect(): void;
     disconnect(): void;
 }
 
-type WireAdapterSchemaValue = 'optional' | 'required';
+export type WireAdapterSchemaValue = 'optional' | 'required';
 
 interface WireDef {
     method?: (data: any) => void;
diff --git a/packages/@lwc/wire-service/src/index.ts b/packages/@lwc/wire-service/src/index.ts
@@ -5,7 +5,7 @@
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
 import { isUndefined } from '@lwc/shared';
-import { WireAdapter, DataCallback } from '@lwc/engine-core';
+import { WireConfigValue, WireAdapter, DataCallback } from '@lwc/engine-core';
 import { ValueChangedEvent } from './value-changed-event';
 
 const { freeze, defineProperty, isExtensible } = Object;
@@ -196,7 +196,7 @@ class LegacyWireAdapterBridge implements WireAdapter {
 
     protected eventTarget: WireEventTarget;
 
-    update(config: Record<string, any>) {
+    update(config: WireConfigValue) {
         if (this.isFirstUpdate) {
             // this is a special case for legacy wire adapters: when all the config params are undefined,
             // the config on the wire adapter should not be called until one of them changes.

Original file line number	Diff line number	Diff line change
`@@ -217,15 +217,15 @@ function createConnector(vm: VM, name: string, wireDef: WireDef): WireAdapter {`
`217`	`217`	`}`
`218`	`218`
`219`	`219`	`export type DataCallback = (value: any) => void;`
`220`		`-type ConfigValue = Record<string, any>;`
	`220`	`+export type ConfigValue = Record<string, any>;`
`221`	`221`
`222`	`222`	`export interface WireAdapter {`
`223`	`223`	`update(config: ConfigValue, context?: ContextValue): void;`
`224`	`224`	`connect(): void;`
`225`	`225`	`disconnect(): void;`
`226`	`226`	`}`
`227`	`227`
`228`		`-type WireAdapterSchemaValue = 'optional' \| 'required';`
	`228`	`+export type WireAdapterSchemaValue = 'optional' \| 'required';`
`229`	`229`
`230`	`230`	`interface WireDef {`
`231`	`231`	`method?: (data: any) => void;`