@lwrjs/types 0.10.0-alpha.8 → 0.10.0

package/build/config.d.ts

@@ -1,4 +1,4 @@
-import { AssetProvider, AssetTransformPlugin, BundleProvider, CacheResponse, LwrService, ModuleProvider, RenderOptions, ResourceProvider, RouteHandlerViewResponse, RuntimeEnvironment, ServerTypes, ServiceCtor, Specifier, ViewParams, ViewProvider, ViewRequest, ViewResponse, ViewTransformPlugin } from './index';
+import type { AssetProvider, AssetTransformPlugin, BundleProvider, CacheResponse, LwrService, ModuleProvider, RenderOptions, ResourceProvider, RouteHandlerViewResponse, RuntimeEnvironment, ServerTypes, ServiceCtor, Specifier, UriTransformPlugin, ViewParams, ViewProvider, ViewRequest, ViewResponse, ViewTransformPlugin } from './index';
 export interface View {
     id: string;
     rootComponent?: string;
@@ -8,7 +8,7 @@ export interface View {
 }
 export interface LwrBaseRoute extends View {
     properties?: Record<string, any>;
-    routeHandler?: string;
+    routeHandler?: ServiceConfig;
     cache?: CacheResponse;
     subRoutes?: string;
 }
@@ -18,12 +18,14 @@ export interface LwrRoute extends LwrBaseRoute {
 }
 export interface NormalizedLwrRoute extends LwrRoute {
     bootstrap: NormalizedLwrAppBootstrapConfig;
+    routeHandler?: ServiceEntry;
 }
 export interface LwrErrorRoute extends LwrBaseRoute {
     status: 404 | 500;
 }
 export interface NormalizedLwrErrorRoute extends LwrErrorRoute {
     bootstrap: NormalizedLwrAppBootstrapConfig;
+    routeHandler?: ServiceEntry;
 }
 export interface NormalizedLwrAppBootstrapConfig {
     autoBoot: boolean;
@@ -44,12 +46,15 @@ export interface LwrLockerConfig {
     clientOnly?: boolean;
 }
 export interface RouteHandlersConfig {
-    [id: string]: string;
+    [id: string]: ServiceConfig;
+}
+export interface NormalizedRouteHandlersConfig {
+    [id: string]: ServiceEntry;
 }
 export interface LocalizedViewRequest extends ViewRequest {
     locale?: string;
 }
-export type RouteHandlerFunction = (viewRequest: LocalizedViewRequest, handlerContext: HandlerContext) => Promise<RouteHandlerViewResponse>;
+export type RouteHandlerFunction = (viewRequest: LocalizedViewRequest, handlerContext: HandlerContext, routeHandlerOptions?: any) => Promise<RouteHandlerViewResponse> | RouteHandlerViewResponse;
 export interface ResourcePaths {
     rootDir: string;
     assets: AssetConfig[];
@@ -59,7 +64,7 @@ export interface ResourcePaths {
 export type RouteHandlerView = Pick<View, 'contentTemplate' | 'layoutTemplate' | 'rootComponent'>;
 export interface RouteHandlerViewApi {
     hasViewResponse(view: RouteHandlerView, viewParams?: ViewParams, renderOptions?: RenderOptions): boolean;
-    getViewResponse(view: RouteHandlerView, viewParams?: ViewParams, renderOptions?: RenderOptions): Promise<ViewResponse | undefined>;
+    getViewResponse(view: RouteHandlerView, viewParams?: ViewParams, renderOptions?: RenderOptions): Promise<ViewResponse>;
 }
 export interface HandlerContext extends ResourcePaths {
     route: LwrRoute | LwrErrorRoute;
@@ -100,6 +105,7 @@ export interface LwrGlobalConfig {
     serverType?: ServerTypes;
     staticSiteGenerator?: StaticSiteGenerator;
     locker?: LwrLockerConfig;
+    uriTransformers?: ServiceConfig[];
 }
 export interface BuildOptions {
     target?: string;
@@ -114,6 +120,7 @@ export interface BuildOptions {
 export interface NormalizedLwrGlobalConfig extends Required<Omit<LwrGlobalConfig, 'lwc'>> {
     routes: NormalizedLwrRoute[];
     errorRoutes: NormalizedLwrErrorRoute[];
+    routeHandlers: NormalizedRouteHandlersConfig;
     assets: AssetConfig[];
     lwrVersion: string;
     amdLoader: string;
@@ -126,6 +133,7 @@ export interface NormalizedLwrGlobalConfig extends Required<Omit<LwrGlobalConfig
     resourceProviders: ServiceEntry[];
     assetProviders: ServiceEntry[];
     assetTransformers: ServiceEntry[];
+    uriTransformers: ServiceEntry[];
     lwc: NormalizedLwcConfig;
 }
 export interface StaticSiteGenerator {
@@ -153,21 +161,27 @@ export interface Services {
     resourceProviders: ResolvedServiceEntry<ResourceProvider>[];
     assetProviders: ResolvedServiceEntry<AssetProvider>[];
     assetTransformers: ResolvedServiceEntry<AssetTransformPlugin>[];
+    uriTransformers: ResolvedServiceEntry<UriTransformPlugin>[];
 }
 export interface RouteHandlers {
-    [id: string]: RouteHandlerFunction;
+    [id: string]: [RouteHandlerFunction, any?];
 }
 interface AssetConfigCommon {
-    urlPath: string;
+    urlPath?: string;
     alias?: string;
 }
 export interface AssetDirConfig extends AssetConfigCommon {
     dir: string;
+    root?: boolean;
+}
+export interface AssetRootDirConfig extends AssetDirConfig {
+    dir: string;
+    root: true;
 }
 export interface AssetFileConfig extends AssetConfigCommon {
     file: string;
 }
-export type AssetConfig = AssetDirConfig | AssetFileConfig;
+export type AssetConfig = AssetRootDirConfig | AssetDirConfig | AssetFileConfig;
 export interface LwcConfig {
     modules: ResolverModuleRecord[];
     interchangeable?: string[];
@@ -185,10 +199,12 @@ export interface BundleConfig {
     UNSAFE_lwrDefaultExclude?: string[];
     external?: Record<string, string>;
     alias?: Record<string, string>;
+    groups?: BundleGroups;
 }
 export interface BundleConfigOverrides extends BundleConfig {
     appendExcludes?: boolean;
 }
+export type BundleGroups = Record<string, string[]>;
 export type Environment = string;
 export interface EnvironmentConfig {
     default?: Environment;
@@ -233,6 +249,14 @@ export interface HooksPlugin {
      *
      */
     initConfigs?: (lwrConfig: NormalizedLwrGlobalConfig, dataConfig: GlobalData, runtimeConfig: RuntimeEnvironment) => Promise<void> | void;
+    /**
+     * Setup instrumentation utilities
+     *
+     * @remarks
+     * - When running LWR server, these hooks are invoked after `initConfigs` hooks and before `onStart` hooks
+     * - When running LWR handler, these hooks are invoked before config normalization and `onStart` hooks
+     */
+    initInstrumentation?: () => void;
     /**
      * Load routes on application start up.
      *

package/build/index.d.ts

@@ -3,11 +3,11 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import type { WatchOptions } from 'chokidar';
-import { EventEmitter } from 'events';
-import fs from 'fs';
-import { Readable } from 'stream';
-import { BundleConfig, EnvironmentConfig, HooksPlugin, LwrLockerConfig, NormalizedLwrErrorRoute, NormalizedLwrGlobalConfig, NormalizedLwrRoute, ResolverModuleRecord, BundleConfigOverrides, RouteHandlers, AssetConfig } from './config.js';
-import { AssetReference, CompiledView, PublicViewRegistry, ViewProvider, ViewRegistry, ViewTransformPlugin } from './views.js';
+import type { EventEmitter } from 'events';
+import type fs from 'fs';
+import type { Readable } from 'stream';
+import type { BundleConfig, EnvironmentConfig, HooksPlugin, LwrLockerConfig, NormalizedLwrErrorRoute, NormalizedLwrGlobalConfig, NormalizedLwrRoute, ResolverModuleRecord, BundleConfigOverrides, RouteHandlers, AssetConfig } from './config.js';
+import type { AssetReference, CompiledView, PublicViewRegistry, ViewProvider, ViewRegistry, ViewTransformPlugin } from './views.js';
 export * from './lwr-shim.js';
 export * from './config.js';
 export * from './server.js';
@@ -111,6 +111,7 @@ export interface DynamicImportReference extends BaseDynamicModuleReference {
 export interface ModuleRecord {
     imports?: ImportModuleReference[];
     dynamicImports?: DynamicImportReference[];
+    importMeta?: ImportMeta[];
 }
 export interface ChildHashObject {
     [specifier: string]: string;
@@ -165,10 +166,11 @@ export interface ServerModeConfig {
     featureFlags: FeatureFlags;
 }
 export interface FeatureFlags extends Record<string, boolean | undefined> {
+    ASSETS_ON_LAMBDA?: boolean;
     LEGACY_LOADER?: boolean;
-    SSR_STATIC_BUNDLES?: boolean;
     SSR_SANDBOX_WORKER?: boolean;
-    ASSETS_ON_LAMBDA?: boolean;
+    SSR_STATIC_BUNDLES?: boolean;
+    EXPERIMENTAL_UNVERSIONED_ALIASES?: boolean;
 }
 export interface RuntimeEnvironment extends ServerModeConfig {
     apiVersion: string;
@@ -282,6 +284,7 @@ export interface BundleProvider {
 }
 export interface ModuleBundler {
     addBundleProviders(providers: BundleProvider[]): void;
+    addBundleTransformers(transformers: UriTransformPlugin[]): void;
     getModuleBundle<T extends AbstractModuleId, R extends RuntimeEnvironment>(moduleId: T, runtimeEnvironment: R, runtimeParams?: RuntimeParams, bundleConfigOverrides?: BundleConfigOverrides): Promise<BundleDefinition>;
     resolveModuleUri(moduleId: Required<Pick<ModuleId, 'specifier' | 'version'>>, runtimeEnvironment: RuntimeEnvironment, runtimeParams?: RuntimeParams, signature?: string): Promise<string>;
     getPublicApi(): PublicModuleBundler;
@@ -337,9 +340,10 @@ export interface AssetIdentifier {
     type?: AssetType;
     importer?: string;
 }
-export interface AssetUri {
+export interface UriDefinition {
     uri: string;
     immutable: boolean;
+    artifactType: ArtifactType;
     entry: string;
     external?: boolean;
 }
@@ -385,27 +389,25 @@ export interface AssetProvider {
     name: string;
     getAsset(assetIdentifier: AssetIdentifier): Promise<AssetSource | undefined>;
 }
-export type TransformPluginContext = Record<string, any>;
-type AssetPluginTransformHook = (code: string | Buffer, assetSource: AssetSource, context?: TransformPluginContext) => Promise<AssetPluginTransformHookReturn>;
-type AssetPluginTransformHookReturn = null | undefined | false | string | Buffer | {
-    code: string | Buffer;
-    context?: TransformPluginContext;
-};
-type AssetPluginExtractMetaHook = (code: string | Buffer, assetSource: AssetSource, context?: TransformPluginContext) => Promise<AssetPluginExtractMetaHookReturn>;
-type AssetPluginExtractMetaHookReturn = null | undefined | false | {
+export type ArtifactType = 'asset' | 'bundle' | 'resource';
+export type ArtifactDefinition = AssetDefinition | BundleDefinition | ResourceDefinition;
+export type AssetTransformSourceHook = (assetSource: AssetSource, runtimeEnvironment: RuntimeEnvironment) => Promise<AssetTransformSourceHookReturn>;
+export type AssetTransformSourceHookReturn = undefined | {
+    source: string | Buffer;
     metadata?: AssetMetadata;
-    context?: TransformPluginContext;
-};
-type AssetPluginOptimizeHook = (code: string | Buffer, assetSource: AssetSource, context?: TransformPluginContext) => Promise<AssetPluginOptimizeHookReturn>;
-type AssetPluginOptimizeHookReturn = null | undefined | false | string | Buffer | {
-    code: string | Buffer;
-    map?: any;
-    context?: TransformPluginContext;
 };
+export type UriTransformHook = (uri: UriDefinition, artifactDef?: ArtifactDefinition, runtimeEnvironment?: RuntimeEnvironment) => Promise<UriTransformHookReturn>;
+export type UriTransformHookReturn = undefined | UriDefinition;
+export interface UriTransformHooks {
+    transformUri: UriTransformHook;
+}
+export interface UriTransformPlugin extends UriTransformHooks {
+    name: string;
+}
+export type AssetUriTransformHook = (uri: UriDefinition, assetDef: AssetDefinition, runtimeEnvironment: RuntimeEnvironment) => Promise<UriTransformHookReturn>;
 export interface AssetTransformHooks {
-    transform: AssetPluginTransformHook;
-    extractMetadata: AssetPluginExtractMetaHook;
-    optimize: AssetPluginOptimizeHook;
+    transformUri: AssetUriTransformHook;
+    transformSource: AssetTransformSourceHook;
 }
 export interface AssetTransformPlugin extends Partial<AssetTransformHooks> {
     name: string;
@@ -413,17 +415,18 @@ export interface AssetTransformPlugin extends Partial<AssetTransformHooks> {
 export interface ResourceRegistry {
     name: string;
     addResourceProviders(provider: ResourceProvider[]): void;
+    addResourceTransformers(provider: UriTransformPlugin[]): void;
     getResource<R extends ResourceIdentifier, T extends RuntimeEnvironment>(resourceIdentity: R, runtimeEnvironment: T, runtimeParams?: RuntimeParams): Promise<ResourceDefinition | undefined>;
-    resolveResourceUri<R extends ResourceIdentifier, T extends RuntimeEnvironment>(resourceIdentity: R, runtimeEnvironment: T): string;
+    resolveResourceUri<R extends ResourceIdentifier, T extends RuntimeEnvironment>(resourceIdentity: R, runtimeEnvironment: T): Promise<string>;
     getPublicApi(): PublicResourceRegistry;
 }
 export type PublicResourceRegistry = Pick<ResourceRegistry, 'getResource' | 'resolveResourceUri'>;
 export interface AssetRegistry {
     name: string;
     addAssetProviders(provider: AssetProvider[]): void;
-    addAssetTransformers(transformers: AssetTransformPlugin[]): void;
+    addAssetTransformers(transformers: (AssetTransformPlugin | UriTransformPlugin)[]): void;
     getAsset<R extends AssetIdentifier, T extends RuntimeEnvironment>(resourceIdentity: R, runtimeEnvironment: T, includeMetadata?: boolean): Promise<AssetDefinition>;
-    resolveAssetUri<R extends AssetIdentifier, T extends RuntimeEnvironment>(resourceIdentity: R, runtimeEnvironment: T): Promise<AssetUri>;
+    resolveAssetUri<R extends AssetIdentifier, T extends RuntimeEnvironment>(resourceIdentity: R, runtimeEnvironment: T): Promise<UriDefinition>;
     getPublicApi(): PublicAssetRegistry;
 }
 export type PublicAssetRegistry = Pick<AssetRegistry, 'getAsset' | 'resolveAssetUri'>;
@@ -431,12 +434,14 @@ export interface LwcCompilerConfig {
     name: string;
     namespace?: string;
     filename: string;
+    enableLightningWebSecurityTransforms?: boolean;
     scopedStyles?: boolean;
 }
 export type SourceMap = string | null | undefined;
 export interface CompiledMetadata {
     imports?: Import[];
     dynamicImports?: DynamicImport[];
+    importMeta?: ImportMeta[];
 }
 export interface SourceLocation {
     startColumn: number;
@@ -453,6 +458,10 @@ export interface DynamicImport {
     importLocation: SourceLocation;
     moduleNameType: ModuleNameType;
 }
+export interface ImportMeta {
+    statement: string;
+    location: SourceLocation;
+}
 export interface CompilerResult {
     code: string;
     map?: SourceMap;
@@ -461,6 +470,15 @@ export interface CompilerResult {
 export interface BundleFiles {
     [filename: string]: string;
 }
+interface ImportMetaEnv {
+    [key: string]: any;
+    SSR: boolean;
+}
+declare global {
+    interface ImportMeta {
+        readonly env: ImportMetaEnv;
+    }
+}
 export interface ClientBootstrapConfig {
     appId?: string;
     bootstrapModule: string;
@@ -617,7 +635,7 @@ export interface SiteBundles {
     bundles: Record<string, SiteBundle>;
 }
 export interface SiteResources {
-    resources: Record<string, SiteArtifact>;
+    resources: Record<string, SiteResource>;
 }
 export interface SiteAssets {
     assets: Record<string, SiteArtifact>;
@@ -626,6 +644,9 @@ export interface SiteArtifact {
     path: string;
     mimeType?: string;
 }
+export interface SiteResource extends SiteArtifact {
+    inline?: boolean;
+}
 export interface SiteBundle extends SiteArtifact {
     version?: Version;
     imports: string[];

package/build/lwr-shim.d.ts

@@ -1,4 +1,4 @@
-import { AssetProvider, HooksPlugin, ModuleProvider, ProviderContext, ResourceProvider, ViewProvider, ViewTransformPlugin } from './index';
+import type { AssetProvider, HooksPlugin, ModuleProvider, ProviderContext, ResourceProvider, ViewProvider, ViewTransformPlugin } from './index';
 interface LwrShim {
     LWC_VERSION: string;
     LEGACY_LOADER: boolean;

package/build/server.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { Application as ExpressApp } from 'express';
-import Koa, { Context } from 'koa';
-import http from 'http';
-import { Readable } from 'stream';
+import type { Application as ExpressApp } from 'express';
+import type { default as Koa, Context } from 'koa';
+import type http from 'http';
+import type { Readable } from 'stream';
 import type { NormalizedLwrGlobalConfig, RuntimeContext, RuntimeEnvironment } from './index.js';
 export type ServerTypes = 'koa' | 'express' | 'fs';
 export type ServerTypeImpl<T extends ServerTypes> = T extends 'koa' ? Koa : T extends 'express' ? ExpressApp : T extends 'fs' ? LwrDispatcher : never;

package/build/serviceAPI/loaderPlugins/loaderPlugins.d.ts

@@ -1,4 +1,4 @@
-import { ImportMetadata } from '../..';
+import type { ImportMetadata } from '../..';
 type ResolveParams = {
     parentUrl: string;
 };

package/build/serviceAPI/serviceAPI.d.ts

@@ -1,6 +1,6 @@
-import { RegisterLoaderHooks } from './loaderPlugins/loaderPlugins';
-import { RegisterHandleStaleModuleHook } from './handleStaleModule/handleStaleModule';
-import { AppMetadata } from './appMetadata/appMetadata';
+import type { RegisterLoaderHooks } from './loaderPlugins/loaderPlugins';
+import type { RegisterHandleStaleModuleHook } from './handleStaleModule/handleStaleModule';
+import type { AppMetadata } from './appMetadata/appMetadata';
 export interface ServiceAPI {
     addLoaderPlugin: NoOp | RegisterLoaderHooks;
     handleStaleModule: RegisterHandleStaleModuleHook;

package/build/views.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-import { LwrErrorRoute, LwrRoute, RouteHandlerFunction, RouteHandlerView, View } from './config.js';
-import { AssetSource, AssetUri, Endpoints, FlattenedModuleGraphs, ImportMetadata, Json, LwrStringBuilder, ResourceDefinition, RuntimeEnvironment, RuntimeParams, Specifier, TransformPluginContext } from './index.js';
+import type { LwrErrorRoute, LwrRoute, RouteHandlerFunction, RouteHandlerView, View } from './config.js';
+import type { AssetSource, UriDefinition, Endpoints, FlattenedModuleGraphs, ImportMetadata, Json, LwrStringBuilder, ResourceDefinition, RuntimeEnvironment, RuntimeParams, Specifier } from './index.js';
 export type ViewIdentity = Pick<View, 'rootComponent' | 'contentTemplate'>;
 export interface ViewSource {
     name: string;
@@ -48,7 +48,7 @@ export interface RenderedViewMetadata {
 export interface RenderedAssetReference {
     url: string;
     tagName?: string;
-    override?: AssetUri;
+    override?: UriDefinition;
 }
 export interface AssetReference extends RenderedAssetReference {
     importer?: string;
@@ -89,6 +89,7 @@ interface ViewRequestQs {
 }
 export interface ViewRequest {
     url: string;
+    originalUrl?: string;
     requestPath: string;
     params?: any;
     query?: ViewRequestQs;
@@ -122,7 +123,7 @@ export interface ViewProvider {
     initialize(): Promise<void>;
     getView(viewId: ViewIdentity): Promise<CompiledView | undefined>;
 }
-export interface ViewTranformPluginContext {
+export interface ViewTransformPluginContext {
     view: View;
     viewParams: ViewParams;
     runtimeEnvironment: RuntimeEnvironment;
@@ -133,17 +134,15 @@ export interface ViewTranformPluginContext {
     };
     importer?: string;
 }
-type ViewPluginLinkHook = (builder: LwrStringBuilder, viewContext: ViewTranformPluginContext, viewMetadata: RenderedViewMetadata, context?: TransformPluginContext) => Promise<ViewPluginLinkHookReturn>;
+type ViewPluginLinkHook = (builder: LwrStringBuilder, viewContext: ViewTransformPluginContext, viewMetadata: RenderedViewMetadata) => Promise<ViewPluginLinkHookReturn>;
 type ViewPluginLinkHookReturn = void | null | undefined | false | LwrStringBuilder | {
     builder?: LwrStringBuilder;
-    context?: TransformPluginContext;
     cache?: CacheResponse;
 };
-type ViewPluginOptimizeHook = (code: string, assetSource: AssetSource, context?: TransformPluginContext) => Promise<ViewPluginOptimizeHookReturn>;
+type ViewPluginOptimizeHook = (code: string, assetSource: AssetSource) => Promise<ViewPluginOptimizeHookReturn>;
 type ViewPluginOptimizeHookReturn = null | undefined | false | string | {
     code: string;
     map?: any;
-    context?: TransformPluginContext;
 };
 export interface ViewTransformHooks {
     link: ViewPluginLinkHook;

package/package.json

@@ -8,7 +8,7 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.10.0-alpha.8",
+    "version": "0.10.0",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -27,7 +27,7 @@
         "chokidar": "^3.5.3"
     },
     "engines": {
-        "node": ">=16.0.0 <20"
+        "node": ">=16.0.0"
     },
-    "gitHead": "46bd72343e1db7c72470033320921df3a7eff18a"
+    "gitHead": "e6deaeef3db8aa079acefed508897eca19b3218a"
 }