@lwrjs/types 0.11.0-alpha.0 → 0.11.0-alpha.10

package/build/config.d.ts

@@ -2,7 +2,7 @@ import type { AssetProvider, AssetTransformPlugin, BundleProvider, CacheResponse
 export interface View {
     id: string;
     rootComponent?: string;
-    contentTemplate?: string;
+    contentTemplate?: string | Record<string, string>;
     layoutTemplate?: string;
     bootstrap?: LwrAppBootstrapConfig;
 }
@@ -27,29 +27,37 @@ export interface NormalizedLwrErrorRoute extends LwrErrorRoute {
     bootstrap: NormalizedLwrAppBootstrapConfig;
     routeHandler?: ServiceEntry;
 }
-export interface NormalizedLwrAppBootstrapConfig {
-    autoBoot: boolean;
-    syntheticShadow: boolean;
-    workers: {
+export interface BootstrapService {
+    name: string;
+    ssr: boolean;
+}
+export interface LwrAppBootstrapConfig {
+    autoBoot?: boolean;
+    syntheticShadow?: boolean;
+    workers?: {
         [id: string]: string;
     };
-    services: string[];
-    configAsSrc: boolean;
-    ssr: boolean;
+    services?: (string | BootstrapService)[];
+    configAsSrc?: boolean;
+    ssr?: boolean;
+    mixedMode?: boolean;
+    module?: string | undefined;
+    preloadModules?: string[];
+}
+export interface NormalizedLwrAppBootstrapConfig extends Required<Omit<LwrAppBootstrapConfig, 'module'>> {
+    services: BootstrapService[];
     module: string | undefined;
-    preloadModules: string[];
 }
-export type LwrAppBootstrapConfig = Partial<NormalizedLwrAppBootstrapConfig>;
 export interface LwrLockerConfig {
     enabled: boolean;
     trustedComponents?: string[];
     clientOnly?: boolean;
 }
 export interface RouteHandlersConfig {
-    [id: string]: ServiceConfig;
+    [id: string]: string | null;
 }
 export interface NormalizedRouteHandlersConfig {
-    [id: string]: ServiceEntry;
+    [id: string]: string | null;
 }
 export interface LocalizedViewRequest extends ViewRequest {
     locale?: string;
@@ -106,7 +114,12 @@ export interface LwrGlobalConfig {
     staticSiteGenerator?: StaticSiteGenerator;
     locker?: LwrLockerConfig;
     uriTransformers?: ServiceConfig[];
+    i18n?: I18NConfig;
 }
+type RequiredPick<T, K extends keyof T> = {
+    [P in K]-?: T[P];
+};
+export type OnStartConfig = RequiredPick<LwrGlobalConfig, 'basePath' | 'i18n' | 'routes'>;
 export interface BuildOptions {
     target?: string;
     input?: string;
@@ -135,10 +148,10 @@ export interface NormalizedLwrGlobalConfig extends Required<Omit<LwrGlobalConfig
     assetTransformers: ServiceEntry[];
     uriTransformers: ServiceEntry[];
     lwc: NormalizedLwcConfig;
+    i18n: I18NConfig;
 }
 export interface StaticSiteGenerator {
     outputDir?: string;
-    locales?: string[];
     skipCleanOutputDir?: boolean;
     skipBaseDocumentGeneration?: boolean;
     _additionalRoutePaths?: string[];
@@ -164,7 +177,7 @@ export interface Services {
     uriTransformers: ResolvedServiceEntry<UriTransformPlugin>[];
 }
 export interface RouteHandlers {
-    [id: string]: [RouteHandlerFunction, any?];
+    [id: string]: RouteHandlerFunction;
 }
 interface AssetConfigCommon {
     urlPath?: string;
@@ -258,7 +271,7 @@ export interface HooksPlugin {
      */
     initInstrumentation?: () => void;
     /**
-     * Load routes on application start up.
+     * Set a subset of LWR Configuration at runtime.  Works in mrt
      *
      * @remarks
      * These hooks are invoked ONLY at runtime.
@@ -267,7 +280,17 @@ export interface HooksPlugin {
      *
      * For the `createHandler` runtime, these hooks are invoked during server context initialization.
      */
-    onStart?: (routes: LwrRoute[]) => void;
+    onStart?: (config: OnStartConfig) => void;
+}
+export interface Locale {
+    id: string;
+    fallback?: string;
+}
+export interface I18NConfig {
+    defaultLocale: string;
+    locales: Locale[];
+    uriPattern?: UriPattern;
 }
+export type UriPattern = undefined | 'path-prefix' | 'query-param';
 export {};
 //# sourceMappingURL=config.d.ts.map

package/build/index.d.ts

@@ -6,7 +6,7 @@ import type { WatchOptions } from 'chokidar';
 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 { BundleConfig, EnvironmentConfig, HooksPlugin, LwrLockerConfig, NormalizedLwrErrorRoute, NormalizedLwrGlobalConfig, NormalizedLwrRoute, ResolverModuleRecord, BundleConfigOverrides, RouteHandlers, AssetConfig, I18NConfig } from './config.js';
 import type { AssetReference, CompiledView, PublicViewRegistry, ViewProvider, ViewRegistry, ViewTransformPlugin } from './views.js';
 export * from './lwr-shim.js';
 export * from './config.js';
@@ -139,7 +139,7 @@ export interface LinkedModuleDefinition extends ModuleDefinition {
     linkedModuleRecord: ModuleRecord;
     linkedConfig: LinkedModuleDefinitionConfig;
     runtimeEnvironment: RuntimeEnvironment;
-    runtimeParams?: RuntimeParams;
+    runtimeParams: RuntimeParams;
 }
 export interface CodeSource {
     code: string;
@@ -165,11 +165,12 @@ export interface ServerModeConfig {
     };
     featureFlags: FeatureFlags;
 }
-export interface FeatureFlags extends Record<string, boolean | undefined> {
+export interface FeatureFlags extends Record<string, boolean | string | undefined> {
     ASSETS_ON_LAMBDA?: boolean;
     LEGACY_LOADER?: boolean;
     SSR_SANDBOX_WORKER?: boolean;
     SSR_STATIC_BUNDLES?: boolean;
+    SSR_WITH_CSR_FALLBACK?: boolean;
     EXPERIMENTAL_UNVERSIONED_ALIASES?: boolean;
 }
 export interface RuntimeEnvironment extends ServerModeConfig {
@@ -178,11 +179,18 @@ export interface RuntimeEnvironment extends ServerModeConfig {
     debug: boolean;
     serverMode: string;
     basePath: string;
+    defaultAssetPath: string;
 }
 export interface SourceMapRuntimeEnvironment extends RuntimeEnvironment {
     sourceMapUrl?: string;
 }
 export type RuntimeParams = Record<string, string | number | boolean | null | undefined | Record<string, string>>;
+export interface EnvironmentContext {
+    basePath: string;
+    locale: string;
+    assetBasePath: string;
+    uiBasePath: string;
+}
 export interface ModuleIdentity {
     signature: string;
     moduleId: AbstractModuleId;
@@ -317,6 +325,7 @@ export interface ProviderAppConfig {
     environment?: EnvironmentConfig;
     bundleConfig: BundleConfig;
     assets: AssetConfig[];
+    i18n: I18NConfig;
 }
 export interface ProviderContext {
     appObserver: Pick<LwrAppObserver, 'onModuleDefinitionChange' | 'onModuleSourceChange' | 'onAssetSourceChange' | 'onViewSourceChange'>;
@@ -487,7 +496,7 @@ export interface ClientBootstrapConfig {
     preloadModules?: string[];
     rootComponent?: string;
     rootComponents?: string[];
-    ssrProps?: Json;
+    serverData?: Json;
     customInit?: Function;
     onError?: Function;
     baseUrl?: string;
@@ -616,10 +625,18 @@ export interface SiteMetadata {
      * Get the current metadata about the pre-built module bundles for the site.
      */
     getSiteBundles(): SiteBundles;
+    /**
+     * Get the current debug metadata about the pre-built module bundles for the site.
+     */
+    getDebugSiteBundles(): SiteBundles;
     /**
      * Get the current metadata about the pre-built resources for the site.
      */
     getSiteResources(): SiteResources;
+    /**
+     * Get the current debug metadata about the pre-built resources for the site.
+     */
+    getDebugSiteResources(): SiteResources;
     /**
      * Get the current metadata about the pre-built assets for the site.
      */

package/build/server.d.ts

@@ -4,7 +4,7 @@ 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';
+import type { I18NConfig, 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;
 export interface FsContext extends Context {
@@ -32,7 +32,6 @@ export interface InternalAppServer<T extends ServerTypes> {
     get(path: string | Array<string>, middleware: MiddlewareFunction): void;
     post(path: string | Array<string>, middleware: MiddlewareFunction): void;
     initRoutes(): void;
-    useCompression(): void;
     getRegexWildcard(): string;
 }
 export type PublicAppServer<T extends ServerTypes> = Pick<InternalAppServer<T>, 'use' | 'all' | 'get' | 'post' | 'getRegexWildcard'>;
@@ -57,6 +56,7 @@ export interface MiddlewareRequest {
     headers: Headers;
     protocol: string;
     locale: string;
+    basePath: string;
     acceptsLanguages(): string[];
     get(field: string): string | undefined;
     cookie(name: string): string | undefined;
@@ -85,7 +85,7 @@ export interface MiddlewareRequest {
     /**
      * Use the request parameters to resolve the runtime context(ie. environment and parameters)
      */
-    getRuntimeContext(defaultRuntimeEnvironment: RuntimeEnvironment): RuntimeContext;
+    getRuntimeContext(defaultRuntimeEnvironment: RuntimeEnvironment, i18n: I18NConfig): RuntimeContext;
 }
 export interface MiddlewareResponse {
     set(header: any): void;

package/build/views.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 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 type ViewIdentity = Pick<View, 'id' | 'rootComponent' | 'contentTemplate'>;
 export interface ViewSource {
     name: string;
     slug: string;
@@ -44,6 +44,12 @@ export interface CustomElementReference {
 export interface RenderedViewMetadata {
     customElements: CustomElementReference[];
     assetReferences: AssetReference[];
+    serverData?: {
+        [prop: string]: Json;
+    };
+    serverDebug?: {
+        message?: string;
+    };
 }
 export interface RenderedAssetReference {
     url: string;
@@ -156,6 +162,7 @@ export interface ViewInfo {
     id: string;
     url: string;
     configAsSrc: boolean;
+    mixedMode: boolean;
 }
 export interface RenderOptions {
     skipMetadataCollection?: boolean;
@@ -167,6 +174,8 @@ export interface ViewPageContext {
     id: string;
     title?: string;
     url: string;
+    basePath?: string;
+    locale?: string;
 }
 export type ViewModuleResourceContext = {
     isPreload?: boolean;
@@ -190,16 +199,18 @@ export interface ViewHandler {
 }
 export interface SsrRequestContext {
     props: Json;
+    url: string;
     params: {
         [key: string]: string;
     };
-    query: {
-        [key: string]: string;
-    };
+    query: ViewRequestQs;
     locale: string;
+    basePath: string;
 }
-export interface PageDataResponse {
-    props?: Json;
+export interface SsrDataResponse {
+    props?: {
+        [prop: string]: Json;
+    };
     markup?: {
         links?: {
             href: string;

package/package.json

@@ -8,7 +8,7 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.11.0-alpha.0",
+    "version": "0.11.0-alpha.10",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -29,5 +29,5 @@
     "engines": {
         "node": ">=16.0.0"
     },
-    "gitHead": "6917abefe32752eeed0f9ba98505ca2b76f1df9d"
+    "gitHead": "34b1e289e8de12531f5624b64512e870157195d4"
 }