@lwrjs/types 0.15.0-alpha.3 → 0.15.0-alpha.30

package/build/config.d.ts

@@ -1,4 +1,4 @@
-import type { AssetProvider, AssetTransformPlugin, BundleProvider, CacheResponse, LwrService, ModuleProvider, RenderOptions, ResourceProvider, RouteHandlerViewResponse, RuntimeEnvironment, ServerContext, ServerTypes, ServiceCtor, Specifier, UriTransformPlugin, ViewParams, ViewProvider, ViewRequest, ViewResponse, ViewTransformPlugin } from './index.js';
+import type { AssetProvider, AssetTransformPlugin, BundleProvider, CacheResponse, DirectToCoreProxy, LwrService, ModuleProvider, RenderOptions, ResourceProvider, RouteHandlerViewResponse, RuntimeEnvironment, ServerContext, ServerTypes, ServiceCtor, Specifier, UriTransformPlugin, ViewParams, ViewProvider, ViewRequest, ViewResponse, ViewTransformPlugin } from './index.js';
 export interface View {
     id: string;
     rootComponent?: string;
@@ -30,6 +30,7 @@ export interface NormalizedLwrErrorRoute extends LwrErrorRoute {
 export interface BootstrapService {
     name: string;
     ssr: boolean;
+    version?: string;
 }
 export interface LwrAppBootstrapConfig {
     autoBoot?: boolean;
@@ -41,11 +42,14 @@ export interface LwrAppBootstrapConfig {
     configAsSrc?: boolean;
     ssr?: boolean;
     preloadData?: boolean;
+    proxyForSSR?: boolean;
+    includeCookiesForSSR?: boolean;
     mixedMode?: boolean;
     module?: string | undefined;
     preloadModules?: string[];
     lwrVersion?: string;
     lwcVersion?: string;
+    preloadResources?: PreloadResources;
 }
 export interface NormalizedLwrAppBootstrapConfig extends Required<Omit<LwrAppBootstrapConfig, 'module'>> {
     services: BootstrapService[];
@@ -111,6 +115,7 @@ export interface LwrGlobalConfig {
     resourceProviders?: ServiceConfig[];
     viewProviders?: ServiceConfig[];
     viewTransformers?: ServiceConfig[];
+    caseSensitiveRoutes?: boolean;
     routes?: LwrRoute[];
     errorRoutes?: LwrErrorRoute[];
     routeHandlers?: RouteHandlersConfig;
@@ -120,11 +125,14 @@ export interface LwrGlobalConfig {
     locker?: LwrLockerConfig;
     uriTransformers?: ServiceConfig[];
     i18n?: I18NConfig;
+    coreProxy?: DirectToCoreProxy | null;
+    unsafeEnableViewLinkCaching?: boolean;
+    _isSsrCompilerEnabled?: boolean;
 }
 type RequiredPick<T, K extends keyof T> = {
     [P in K]-?: T[P];
 };
-export type OnStartConfig = RequiredPick<LwrGlobalConfig, 'basePath' | 'i18n' | 'routes' | 'errorRoutes'>;
+export type OnStartConfig = RequiredPick<LwrGlobalConfig, '_isSsrCompilerEnabled' | 'assets' | 'basePath' | 'coreProxy' | 'errorRoutes' | 'i18n' | 'routes'>;
 export interface BuildOptions {
     target?: string;
     input?: string;
@@ -310,7 +318,15 @@ export interface I18NConfig {
     defaultLocale: string;
     locales: Locale[];
     uriPattern?: UriPattern;
+    defaultRedirectParams?: Record<string, string>;
 }
 export type UriPattern = undefined | 'path-prefix';
+export interface PreloadResources {
+    patterns: PreloadResourcePatterns[];
+}
+export interface PreloadResourcePatterns {
+    match: string | string[];
+    attributes?: Record<string, string>;
+}
 export {};
 //# sourceMappingURL=config.d.ts.map

package/build/index.d.ts

@@ -7,7 +7,7 @@ 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, I18NConfig, ModuleRegistryConfig } from './config.js';
-import type { AssetReference, CompiledView, PublicViewRegistry, ViewProvider, ViewRegistry, ViewTransformPlugin } from './views.js';
+import type { AssetReference, CompiledView, DirectToCoreProxy, PublicViewRegistry, ViewProvider, ViewRegistry, ViewTransformPlugin } from './views.js';
 export * from './lwr-shim.js';
 export * from './config.js';
 export * from './cli.js';
@@ -179,6 +179,7 @@ export interface FeatureFlags extends Record<string, boolean | string | undefine
     MAX_VIEW_CACHE_TTL?: string;
     REEVALUATE_MODULES?: boolean;
     SINGLE_RENDER_MODE?: boolean;
+    SSR_LOADER_PER_REQUEST?: boolean;
 }
 export interface RuntimeEnvironment extends ServerModeConfig {
     apiVersion: string;
@@ -191,7 +192,9 @@ export interface RuntimeEnvironment extends ServerModeConfig {
 export interface SourceMapRuntimeEnvironment extends RuntimeEnvironment {
     sourceMapUrl?: string;
 }
-export type RuntimeParams = Record<string, string | number | boolean | null | undefined | Record<string, string>>;
+export type RuntimeParams = Record<string, string | number | boolean | null | undefined | string[] | Record<string, string> | DirectToCoreProxy> & {
+    requestCache?: Record<string, any>;
+};
 export interface EnvironmentContext {
     basePath: string;
     locale: string;
@@ -317,7 +320,7 @@ export interface BundleRecord {
     includedModules: string[];
 }
 export interface BundleDefinition extends ModuleId {
-    code: string;
+    getCode: () => Promise<string>;
     config: BundleConfig;
     map?: any;
     bundleRecord: BundleRecord;
@@ -341,6 +344,7 @@ export interface ProviderAppConfig {
     bundleConfig: BundleConfig;
     assets: AssetConfig[];
     i18n: I18NConfig;
+    _isSsrCompilerEnabled: boolean;
 }
 export interface ProviderContext {
     appObserver: Pick<LwrAppObserver, 'onModuleDefinitionChange' | 'onModuleSourceChange' | 'onAssetSourceChange' | 'onViewSourceChange'>;
@@ -642,7 +646,7 @@ export interface DecisionTree<Artifact extends SiteArtifact> {
     /**
      * Retrieve an artifact from the tree based on a path of decisions
      */
-    find(siteArtifactId: string | Partial<AbstractModuleId>, debug?: boolean, localeId?: string): Artifact | undefined;
+    find(siteArtifactId: string | Partial<AbstractModuleId>, debug?: boolean, ssr?: boolean, localeId?: string): Artifact | undefined;
 }
 export interface SiteMetadata {
     /**

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 { DirectToCoreProxy, 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 {
@@ -37,6 +37,7 @@ export interface InternalAppServer<T extends ServerTypes> {
 export type InternalAppServerOptions = {
     app?: ServerTypeImpl<ServerTypes>;
     basePath?: string;
+    caseSensitiveRoutes?: boolean;
 };
 export interface InternalAppServerConstructable {
     new (options: InternalAppServerOptions): InternalAppServer<ServerTypes>;
@@ -89,6 +90,10 @@ export interface MiddlewareRequest {
      * Use the request parameters to resolve the runtime context(ie. environment and parameters)
      */
     getRuntimeContext(defaultRuntimeEnvironment: RuntimeEnvironment): RuntimeContext;
+    /**
+     * Resolve the Direct-to-Core proxy values for the SSR wrapped fetch endowment
+     */
+    getCoreProxy(appCoreProxy?: DirectToCoreProxy, proxyForSSR?: boolean): DirectToCoreProxy | undefined;
 }
 export interface MiddlewareResponse {
     hasHeader(name: string): boolean;

package/build/serviceAPI/serviceAPI.d.ts

@@ -11,6 +11,16 @@ export interface ServerDataCallback {
 interface RegisterServerDataCallback {
     (hook: ServerDataCallback): void;
 }
+export type RequestHookParams = {
+    cookies: RequestHookCookies;
+};
+export type RequestHookCookies = Record<string, string> | null;
+export interface RequestHook {
+    (params: RequestHookParams): void | null;
+}
+interface RegisterRequestHook {
+    (hook: RequestHook): void;
+}
 export interface ServiceAPI {
     addLoaderPlugin: NoOp | RegisterLoaderHooks;
     handleStaleModule: RegisterHandleStaleModuleHook;
@@ -20,6 +30,7 @@ export interface ServiceAPI {
 export interface ServerServiceAPI {
     addLoaderPlugin: NoOp | RegisterLoaderHooks;
     addServerDataCallback: RegisterServerDataCallback;
+    addRequestHook: RegisterRequestHook;
 }
 export interface NoOp {
     (): void;

package/build/views.d.ts

@@ -18,12 +18,15 @@ export interface CompiledView extends ViewSource {
     };
     render: (context: any, runtimeEnvironment: RuntimeEnvironment) => Promise<RenderingResult>;
 }
-export type NormalizedRenderingResult = Required<RenderingResult>;
+export type NormalizedRenderingResult = Required<Pick<RenderingResult, 'renderedView' | 'metadata' | 'options' | 'cache'>> & {
+    redirect?: SsrRedirect;
+};
 export interface RenderingResult {
     renderedView: string;
     metadata?: RenderedViewMetadata;
     options?: RenderOptions;
     cache?: CacheResponse;
+    redirect?: SsrRedirect;
 }
 export interface RenderedView extends NormalizedRenderingResult {
     compiledView: CompiledView;
@@ -86,6 +89,7 @@ export interface LinkedViewDefinition {
     viewRecord: RenderedViewRecord;
     immutable: boolean;
     cache?: CacheResponse;
+    redirect?: SsrRedirect;
     nonce?: string;
 }
 export interface ViewRequestQs {
@@ -123,6 +127,9 @@ export interface ViewDefinitionResponse {
     headers?: Record<string, string>;
     cookie?: 'wip';
     locale?: string;
+    metadata?: {
+        viewDefinition?: LinkedViewDefinition;
+    };
 }
 export interface ViewProvider {
     name: string;
@@ -147,6 +154,7 @@ type ViewPluginLinkHook = (builder: LwrStringBuilder, viewContext: ViewTransform
 type ViewPluginLinkHookReturn = void | null | undefined | false | LwrStringBuilder | {
     builder?: LwrStringBuilder;
     cache?: CacheResponse;
+    redirect?: SsrRedirect;
 };
 type ViewPluginOptimizeHook = (code: string, assetSource: AssetSource) => Promise<ViewPluginOptimizeHookReturn>;
 type ViewPluginOptimizeHookReturn = null | undefined | false | string | {
@@ -167,6 +175,7 @@ export interface ViewInfo {
     configAsSrc: boolean;
     mixedMode: boolean;
     nonce?: string;
+    ssr: boolean;
 }
 export interface RenderOptions {
     skipMetadataCollection?: boolean;
@@ -177,9 +186,11 @@ export interface ViewPageContext {
     id: string;
     title?: string;
     url: string;
+    assetBasePath?: string;
     basePath?: string;
     locale?: string;
     nonce?: string;
+    uiBasePath?: string;
 }
 export type ViewModuleResourceContext = {
     isPreload?: boolean;
@@ -212,6 +223,7 @@ export interface SsrRequestContext {
     query: ViewRequestQs;
     locale: string;
     basePath: string;
+    crossRequestCache: Record<string, any>;
 }
 export interface SsrRequestOptions {
     bundleSpecifier: string;
@@ -247,6 +259,16 @@ export interface SsrDataResponse {
         }[];
     };
     cache?: CacheResponse;
+    redirect?: SsrRedirect;
+}
+export interface SsrRedirect {
+    status?: 301 | 302;
+    location: string;
+}
+export interface DirectToCoreProxy {
+    origin: string;
+    host?: string;
+    servername?: string;
 }
 export {};
 //# sourceMappingURL=views.d.ts.map

package/package.json

@@ -8,7 +8,7 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.15.0-alpha.3",
+    "version": "0.15.0-alpha.30",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -29,5 +29,5 @@
     "engines": {
         "node": ">=18.0.0"
     },
-    "gitHead": "6dfe76aa313a8ee1cedcf33b466df48a8f1a62eb"
+    "gitHead": "b563560f1d3ccbb6d6bab8a8a5d7b6a8456b9c48"
 }