@lwc/engine-core 8.0.0-alpha.0 → 8.0.0

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

@@ -3,6 +3,6 @@
  * LWC Components. This function implements the internals of this
  * decorator.
  */
-export default function api(value: unknown, context: ClassMemberDecoratorContext | string | symbol): void;
+export default function api(value: unknown, context: ClassMemberDecoratorContext): void;
 export declare function createPublicPropertyDescriptor(key: string): PropertyDescriptor;
 export declare function createPublicAccessorDescriptor(key: PropertyKey, descriptor: PropertyDescriptor): PropertyDescriptor;

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

@@ -3,5 +3,6 @@
  * LWC Components. This function can also be invoked directly
  * with any value to obtain the trackable version of the value.
  */
-export default function track(value: unknown, context: ClassMemberDecoratorContext | string | symbol): void;
+export default function track(target: undefined, context: ClassFieldDecoratorContext): void;
+export default function track<T>(target: T, context?: never): T;
 export declare function internalTrackDecorator(key: string): PropertyDescriptor;

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

@@ -1,4 +1,18 @@
-import { WireAdapterConstructor } from '../wiring';
+import type { LightningElement } from '../base-lightning-element';
+import type { ConfigValue, ContextValue, ReplaceReactiveValues, WireAdapterConstructor } from '../wiring';
+/**
+ * The decorator returned by `@wire()`; not the `wire` function.
+ *
+ * For TypeScript users:
+ * - If you are seeing an unclear error message, ensure that both the type of the decorated prop and
+ * the config used match the types expected by the wire adapter.
+ * - String literal types in the config are resolved to the corresponding prop on the component.
+ * For example, a component with `id = 555` and `@wire(getBook, {id: "$id"} as const) book` will
+ * have `"$id"` resolve to type `number`.
+ */
+interface WireDecorator<Value, Class> {
+    (target: unknown, context: ClassFieldDecoratorContext<Class, Value | undefined> | ClassMethodDecoratorContext<Class, Value extends (value: any) => any ? Value : (this: Class, value: Value) => void> | ClassGetterDecoratorContext<Class, Value | undefined> | ClassSetterDecoratorContext<Class, Value>): void;
+}
 /**
  * Decorator factory to wire a property or method to a wire adapter data source.
  * @param adapter the adapter used to provision data
@@ -10,5 +24,6 @@ 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, Class = LightningElement>(adapter: WireAdapterConstructor<ReplaceReactiveValues<ReactiveConfig, Class>, Value, Context>, config?: ReactiveConfig): WireDecorator<Value, Class>;
 export declare function internalWireFieldDecorator(key: string): PropertyDescriptor;
+export {};

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, } from './types';
 export { connectWireAdapters, disconnectWireAdapters, installWireAdapters, storeWiredFieldMeta, storeWiredMethodMeta, } from './wiring';

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

@@ -49,3 +49,18 @@ export interface ContextProviderOptions {
 }
 export type ContextProvider = (elmOrComponent: EventTarget, options: ContextProviderOptions) => void;
 export type RegisterContextProviderFn = (element: HostElement, adapterContextToken: string, onContextSubscription: WireContextSubscriptionCallback) => void;
+/** Resolves a property chain to the corresponding value on the target type. */
+type ResolveReactiveValue<
+/** The object to search for properties; initially the component. */
+Target, 
+/** A string representing a chain of of property keys, e.g. "data.user.name". */
+Keys extends string> = Keys extends `${infer FirstKey}.${infer Rest}` ? FirstKey extends keyof Target ? ResolveReactiveValue<Target[FirstKey], Rest> : undefined : Keys extends keyof Target ? Target[Keys] : undefined;
+/**
+ * Detects if the `Value` type is a property chain starting with "$". If so, it resolves the
+ * properties to the corresponding value on the target type.
+ */
+type ResolveValueIfReactive<Value, Target> = Value extends string ? string extends Value ? any : Value extends `$${infer Keys}` ? ResolveReactiveValue<Target, Keys> : Value : Value;
+export type ReplaceReactiveValues<Config extends ConfigValue, Component> = {
+    [K in keyof Config]: ResolveValueIfReactive<Config[K], Component>;
+};
+export {};

package/dist/index.cjs.js

@@ -2378,7 +2378,9 @@ function createPublicAccessorDescriptor(key, descriptor) {
  * SPDX-License-Identifier: MIT
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
-function track(target) {
+function track(target, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+context) {
     if (arguments.length === 1) {
         return getReactiveProxy(target);
     }
@@ -5856,6 +5858,12 @@ function getVMBeingRendered() {
 function setVMBeingRendered(vm) {
     vmBeingRendered = vm;
 }
+const VALID_SCOPE_TOKEN_REGEX = /^[a-zA-Z0-9\-_.]+$/;
+// See W-16614556
+// TODO [#2826]: freeze the template object
+function isValidScopeToken(token) {
+    return shared.isString(token) && VALID_SCOPE_TOKEN_REGEX.test(token);
+}
 function validateSlots(vm) {
     assertNotProd(); // this method should never leak to prod
     const { cmpSlots } = vm;
@@ -6008,9 +6016,9 @@ function buildParseFragmentFn(createFragmentFn) {
                 }
             }
             // See W-16614556
-            if ((hasStyleToken && !shared.isString(stylesheetToken)) ||
-                (hasLegacyToken && !shared.isString(legacyStylesheetToken))) {
-                throw new Error('stylesheet token must be a string');
+            if ((hasStyleToken && !isValidScopeToken(stylesheetToken)) ||
+                (hasLegacyToken && !isValidScopeToken(legacyStylesheetToken))) {
+                throw new Error('stylesheet token must be a valid string');
             }
             // If legacy stylesheet tokens are required, then add them to the rendered string
             const stylesheetTokenToRender = stylesheetToken + (hasLegacyToken ? ` ${legacyStylesheetToken}` : '');
@@ -8134,5 +8142,5 @@ exports.swapTemplate = swapTemplate;
 exports.track = track;
 exports.unwrap = unwrap;
 exports.wire = wire;
-/** version: 7.2.4 */
+/** version: 8.0.0 */
 //# sourceMappingURL=index.cjs.js.map