@lwrjs/types 0.11.0-alpha.8 → 0.11.0

package/build/config.d.ts

@@ -119,7 +119,7 @@ export interface LwrGlobalConfig {
 type RequiredPick<T, K extends keyof T> = {
     [P in K]-?: T[P];
 };
-export type OnStartConfig = RequiredPick<LwrGlobalConfig, 'basePath' | 'i18n' | 'routes'>;
+export type OnStartConfig = RequiredPick<LwrGlobalConfig, 'basePath' | 'i18n' | 'routes' | 'errorRoutes'>;
 export interface BuildOptions {
     target?: string;
     input?: string;
@@ -152,7 +152,6 @@ export interface NormalizedLwrGlobalConfig extends Required<Omit<LwrGlobalConfig
 }
 export interface StaticSiteGenerator {
     outputDir?: string;
-    locales?: string[];
     skipCleanOutputDir?: boolean;
     skipBaseDocumentGeneration?: boolean;
     _additionalRoutePaths?: string[];

package/build/index.d.ts

@@ -157,7 +157,7 @@ export interface ServerModeConfig {
     compat: CompatMode;
     watchFiles: boolean;
     debug: boolean;
-    defaultLocale: string;
+    i18n: I18NConfig;
     hmrEnabled: boolean;
     immutableAssets: boolean;
     env: {
@@ -165,7 +165,7 @@ 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;
@@ -179,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;
@@ -481,6 +488,9 @@ declare global {
         readonly env: ImportMetaEnv;
     }
 }
+export type ServerData = {
+    [prop: string]: Json;
+};
 export interface ClientBootstrapConfig {
     appId?: string;
     bootstrapModule: string;
@@ -489,7 +499,7 @@ export interface ClientBootstrapConfig {
     preloadModules?: string[];
     rootComponent?: string;
     rootComponents?: string[];
-    serverData?: Json;
+    serverData?: ServerData;
     customInit?: Function;
     onError?: Function;
     baseUrl?: string;
@@ -660,6 +670,7 @@ export interface SiteResource extends SiteArtifact {
 export interface SiteBundle extends SiteArtifact {
     version?: Version;
     imports: string[];
+    dynamicImports?: string[];
     includedModules?: string[];
 }
 //# sourceMappingURL=index.d.ts.map

package/build/server.d.ts

@@ -56,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;

package/build/serviceAPI/serviceAPI.d.ts

@@ -1,7 +1,11 @@
+import type { ServerData } from '../index';
 import type { RegisterLoaderHooks } from './loaderPlugins/loaderPlugins';
 import type { RegisterHandleStaleModuleHook } from './handleStaleModule/handleStaleModule';
 import type { AppMetadata } from './appMetadata/appMetadata';
-export interface ServiceAPI {
+export interface DataServiceAPI {
+    serverData: ServerData;
+}
+export interface ServiceAPI extends DataServiceAPI {
     addLoaderPlugin: NoOp | RegisterLoaderHooks;
     handleStaleModule: RegisterHandleStaleModuleHook;
     appMetadata: AppMetadata;

package/build/views.d.ts

@@ -1,6 +1,6 @@
 /// <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';
+import type { AssetSource, UriDefinition, Endpoints, FlattenedModuleGraphs, ImportMetadata, Json, LwrStringBuilder, ResourceDefinition, RuntimeEnvironment, RuntimeParams, Specifier, ServerData } from './index.js';
 export type ViewIdentity = Pick<View, 'id' | 'rootComponent' | 'contentTemplate'>;
 export interface ViewSource {
     name: string;
@@ -44,8 +44,9 @@ export interface CustomElementReference {
 export interface RenderedViewMetadata {
     customElements: CustomElementReference[];
     assetReferences: AssetReference[];
-    serverData?: {
-        [prop: string]: Json;
+    serverData?: ServerData;
+    serverDebug?: {
+        message?: string;
     };
 }
 export interface RenderedAssetReference {
@@ -124,7 +125,7 @@ export interface ViewDefinitionResponse {
 export interface ViewProvider {
     name: string;
     initialize(): Promise<void>;
-    getView(viewId: ViewIdentity, runtimeParams: RuntimeParams): Promise<CompiledView | undefined>;
+    getView(viewId: ViewIdentity): Promise<CompiledView | undefined>;
 }
 export interface ViewTransformPluginContext {
     view: View;
@@ -171,6 +172,8 @@ export interface ViewPageContext {
     id: string;
     title?: string;
     url: string;
+    basePath?: string;
+    locale?: string;
 }
 export type ViewModuleResourceContext = {
     isPreload?: boolean;
@@ -181,7 +184,7 @@ export interface ViewRegistry {
     addViewProviders(providers: ViewProvider[]): void;
     addViewTransformers(transformers: ViewTransformPlugin[]): void;
     initializeViewProviders(): Promise<void[]>;
-    getView(viewId: ViewIdentity, runtimeParams: RuntimeParams, skipCaching?: boolean): Promise<CompiledView>;
+    getView(viewId: ViewIdentity, skipCaching?: boolean): Promise<CompiledView>;
     getViewDefinition<R extends RuntimeEnvironment>(view: View, viewParams: ViewParams, runtimeEnvironment: R, runtimeParams?: RuntimeParams, renderOptions?: RenderOptions): Promise<LinkedViewDefinition>;
     hasViewDefinition<R extends RuntimeEnvironment>(view: View, viewParams: ViewParams, runtimeEnvironment: R, runtimeParams?: RuntimeParams, renderOptions?: RenderOptions): boolean;
     getPublicApi(): PublicViewRegistry;
@@ -194,13 +197,13 @@ 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 SsrDataResponse {
     props?: {

package/package.json

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