@lwc/engine-core 7.2.0 → 7.3.0-alpha.0

package/dist/framework/decorators/wire.d.ts

@@ -1,4 +1,4 @@
-import { WireAdapterConstructor } from '../wiring';
+import type { ConfigValue, ContextValue, ReplaceReactiveValues, WireAdapterConstructor, WireDecorator } from '../wiring';
 /**
  * Decorator factory to wire a property or method to a wire adapter data source.
  * @param adapter the adapter used to provision data
@@ -10,5 +10,5 @@ import { WireAdapterConstructor } from '../wiring';
  *   \@wire(getBook, { id: '$bookId'}) book;
  * }
  */
-export default function wire(adapter: WireAdapterConstructor, config?: Record<string, any>): (value: unknown, context: ClassMemberDecoratorContext | string | symbol) => void;
+export default function wire<ReactiveConfig extends ConfigValue = ConfigValue, Value = any, Context extends ContextValue = ContextValue>(adapter: WireAdapterConstructor<ReplaceReactiveValues<ReactiveConfig>, Value, Context>, config?: ReactiveConfig): WireDecorator<Value>;
 export declare function internalWireFieldDecorator(key: string): PropertyDescriptor;

package/dist/framework/wiring/index.d.ts

@@ -1,3 +1,3 @@
 export { createContextProviderWithRegister, createContextWatcher } from './context';
-export { ConfigCallback, ConfigValue, ContextConsumer, ContextProvider, ContextValue, DataCallback, WireAdapter, WireAdapterConstructor, WireAdapterSchemaValue, WireContextSubscriptionPayload, WireContextSubscriptionCallback, } from './types';
+export { ConfigCallback, ConfigValue, ContextConsumer, ContextProvider, ContextValue, DataCallback, ReplaceReactiveValues, WireAdapter, WireAdapterConstructor, WireAdapterSchemaValue, WireContextSubscriptionPayload, WireContextSubscriptionCallback, WireDecorator, } from './types';
 export { connectWireAdapters, disconnectWireAdapters, installWireAdapters, storeWiredFieldMeta, storeWiredMethodMeta, } from './wiring';

package/dist/framework/wiring/types.d.ts

@@ -16,6 +16,26 @@ export interface WireAdapterConstructor<Config extends ConfigValue = ConfigValue
     configSchema?: Record<keyof Config, WireAdapterSchemaValue>;
     contextSchema?: Record<keyof Context, WireAdapterSchemaValue>;
 }
+/**
+ * The decorator returned by `@wire()`; not the `wire` factory function.
+ *
+ * If you're using `@wire(adapter) property` and getting an opaque type error, ensure that the
+ * property is explicitly typed and the type matches the value used by the adapter. Note that one
+ * of the following conditions must always be true:
+ * - The adapter uses `undefined` as a possible value
+ * - The property is marked as optional
+ * - The property is assigned a default value (not provided by the adapter)
+ */
+export interface WireDecorator<Value = any> {
+    /** Property decorator for `"experimentalDecorators": false`. */
+    <Class extends LightningElement>(target: undefined, ctx: ClassFieldDecoratorContext<Class, Value>): void;
+    /** Method decorator for `"experimentalDecorators": false`. */
+    <Class extends LightningElement>(target: DataCallback<Value>, ctx: ClassMethodDecoratorContext<Class, DataCallback<Value>>): void | DataCallback<Value>;
+    /** Property decorator for `"experimentalDecorators": true`. */
+    <K extends string | symbol>(target: Record<K, Value>, propertyKey: K): void;
+    /** Method decorator for `"experimentalDecorators": true`. */
+    <K extends string | symbol>(target: Record<K, DataCallback<Value>>, propertyKey: K, descriptor: TypedPropertyDescriptor<DataCallback<Value>>): void;
+}
 export interface WireDef {
     method?: (data: any) => void;
     adapter: WireAdapterConstructor;
@@ -49,3 +69,11 @@ export interface ContextProviderOptions {
 }
 export type ContextProvider = (elmOrComponent: EventTarget, options: ContextProviderOptions) => void;
 export type RegisterContextProviderFn = (element: HostElement, adapterContextToken: string, onContextSubscription: WireContextSubscriptionCallback) => void;
+/**
+ * String values starting with "$" are reactive; they get replaced by values from the component.
+ * We don't have access to the component, and we don't expect all reactive strings to be typed as
+ * literals, so we just replace all strings with `any`.
+ */
+export type ReplaceReactiveValues<T> = {
+    [K in keyof T]: T[K] extends string ? any : T[K];
+};

package/dist/index.cjs.js

@@ -5345,14 +5345,14 @@ function i(iterable, factory) {
     // TODO [#1276]: compiler should give us some sort of indicator when a vnodes collection is dynamic
     sc(list);
     const vmBeingRendered = getVMBeingRendered();
-    if (shared.isUndefined(iterable) || iterable === null) {
+    if (shared.isUndefined(iterable) || shared.isNull(iterable)) {
         if (process.env.NODE_ENV !== 'production') {
-            logError(`Invalid template iteration for value "${shared.toString(iterable)}" in ${vmBeingRendered}. It must be an Array or an iterable Object.`, vmBeingRendered);
+            logError(`Invalid template iteration for value \`${shared.toString(iterable)}\` in ${vmBeingRendered}. It must be an array-like object.`, vmBeingRendered);
         }
         return list;
     }
     if (process.env.NODE_ENV !== 'production') {
-        shared.assert.isFalse(shared.isUndefined(iterable[SymbolIterator]), `Invalid template iteration for value \`${shared.toString(iterable)}\` in ${vmBeingRendered}. It must be an array-like object and not \`null\` nor \`undefined\`.`);
+        shared.assert.isFalse(shared.isUndefined(iterable[SymbolIterator]), `Invalid template iteration for value \`${shared.toString(iterable)}\` in ${vmBeingRendered}. It must be an array-like object.`);
     }
     const iterator = iterable[SymbolIterator]();
     if (process.env.NODE_ENV !== 'production') {
@@ -5489,9 +5489,6 @@ function k(compilerKey, obj) {
 function gid(id) {
     const vmBeingRendered = getVMBeingRendered();
     if (shared.isUndefined(id) || id === '') {
-        if (process.env.NODE_ENV !== 'production') {
-            logError(`Invalid id value "${id}". The id attribute must contain a non-empty string.`, vmBeingRendered);
-        }
         return id;
     }
     // We remove attributes when they are assigned a value of null
@@ -5508,11 +5505,6 @@ function gid(id) {
 function fid(url) {
     const vmBeingRendered = getVMBeingRendered();
     if (shared.isUndefined(url) || url === '') {
-        if (process.env.NODE_ENV !== 'production') {
-            if (shared.isUndefined(url)) {
-                logError(`Undefined url value for "href" or "xlink:href" attribute. Expected a non-empty string.`, vmBeingRendered);
-            }
-        }
         return url;
     }
     // We remove attributes when they are assigned a value of null