@lwrjs/types 0.12.0-alpha.2 → 0.12.0-alpha.21

package/build/config.d.ts

@@ -1,4 +1,4 @@
-import type { AssetProvider, AssetTransformPlugin, BundleProvider, CacheResponse, LwrService, ModuleProvider, RenderOptions, ResourceProvider, RouteHandlerViewResponse, RuntimeEnvironment, ServerTypes, ServiceCtor, Specifier, UriTransformPlugin, ViewParams, ViewProvider, ViewRequest, ViewResponse, ViewTransformPlugin } from './index';
+import type { AssetProvider, AssetTransformPlugin, BundleProvider, CacheResponse, LwrService, ModuleProvider, RenderOptions, ResourceProvider, RouteHandlerViewResponse, RuntimeEnvironment, ServerContext, ServerTypes, ServiceCtor, Specifier, UriTransformPlugin, ViewParams, ViewProvider, ViewRequest, ViewResponse, ViewTransformPlugin } from './index';
 export interface View {
     id: string;
     rootComponent?: string;
@@ -40,6 +40,7 @@ export interface LwrAppBootstrapConfig {
     services?: (string | BootstrapService)[];
     configAsSrc?: boolean;
     ssr?: boolean;
+    preloadData?: boolean;
     mixedMode?: boolean;
     module?: string | undefined;
     preloadModules?: string[];
@@ -60,6 +61,7 @@ export interface NormalizedRouteHandlersConfig {
 }
 export interface LocalizedViewRequest extends ViewRequest {
     locale?: string;
+    basePath?: string;
 }
 export type RouteHandlerFunction = (viewRequest: LocalizedViewRequest, handlerContext: HandlerContext, routeHandlerOptions?: any) => Promise<RouteHandlerViewResponse> | RouteHandlerViewResponse;
 export interface ResourcePaths {
@@ -213,6 +215,9 @@ export interface BundleConfig {
     alias?: Record<string, string>;
     groups?: BundleGroups;
 }
+export interface ModuleRegistryConfig {
+    bundleConfig: BundleConfig;
+}
 export interface BundleConfigOverrides extends BundleConfig {
     appendExcludes?: boolean;
 }
@@ -242,6 +247,9 @@ export interface InterchangeableModuleRecord {
         [target: string]: string;
     };
 }
+export interface Instrumentation {
+    flush(): void;
+}
 export interface HooksPlugin {
     /**
      * Programmatically modify application and runtime configurations.
@@ -268,7 +276,7 @@ export interface HooksPlugin {
      * - 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;
+    initInstrumentation?: () => Instrumentation;
     /**
      * Set a subset of LWR Configuration at runtime.  Works in mrt
      *
@@ -280,6 +288,15 @@ export interface HooksPlugin {
      * For the `createHandler` runtime, these hooks are invoked during server context initialization.
      */
     onStart?: (config: OnStartConfig) => void;
+    /**
+     *
+     * Attach instantiated route handlers, providers, and transformers directly to the server context.
+     *
+     * @remarks
+     * This is a temporary hook to enable a tactical solution for LWR@MRT local development
+     *
+     */
+    setupServerContext?: (context: ServerContext, startHooks: HooksPlugin[]) => Promise<void> | void;
 }
 export interface Locale {
     id: string;
@@ -290,6 +307,6 @@ export interface I18NConfig {
     locales: Locale[];
     uriPattern?: UriPattern;
 }
-export type UriPattern = undefined | 'path-prefix' | 'query-param';
+export type UriPattern = undefined | 'path-prefix';
 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, I18NConfig } from './config.js';
+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';
 export * from './lwr-shim.js';
 export * from './config.js';
@@ -73,6 +73,7 @@ interface BaseModuleEntry {
     id: string;
     entry: string;
     virtual?: boolean;
+    external?: boolean;
     scope?: string;
     specifier: Specifier;
     version: Version;
@@ -92,6 +93,7 @@ export interface BaseModuleReference {
     specifier: string;
     version: Version;
     interchangeable?: boolean;
+    externalSrc?: string;
 }
 export interface ImportModuleReference extends BaseModuleReference {
     sourceSpecifier: Specifier;
@@ -283,9 +285,10 @@ export interface ModuleRegistry {
     getModuleEntry(moduleId: AbstractModuleId, runtimeParams?: RuntimeParams): Promise<ModuleEntry>;
     resolveModuleUri<R extends RuntimeEnvironment, S extends string | undefined>(moduleId: Required<Pick<ModuleId, 'specifier' | 'version'>>, runtimeEnvironment: R, runtimeParams?: RuntimeParams, signature?: S): Promise<string>;
     resolveModuleUriSync<R extends RuntimeEnvironment, S extends string | undefined>(moduleId: Required<Pick<ModuleId, 'specifier' | 'version'>>, signature: S, runtimeEnvironment: R, runtimeParams?: RuntimeParams): string;
+    getConfig(): ModuleRegistryConfig;
     getPublicApi(): PublicModuleRegistry;
 }
-export type PublicModuleRegistry = Pick<ModuleRegistry, 'getModule' | 'getModuleEntry' | 'getLinkedModule' | 'resolveModuleUri'>;
+export type PublicModuleRegistry = Pick<ModuleRegistry, 'getConfig' | 'getModule' | 'getModuleEntry' | 'getLinkedModule' | 'resolveModuleUri'>;
 export interface BundleProvider {
     name: string;
     bundle<T extends AbstractModuleId, R extends RuntimeEnvironment>(moduleId: T, runtimeEnvironment: R, runtimeParams: RuntimeParams, configOverrides?: BundleConfig): Promise<BundleDefinition | undefined>;
@@ -295,9 +298,10 @@ export interface ModuleBundler {
     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>;
+    getConfig(): BundleConfig;
     getPublicApi(): PublicModuleBundler;
 }
-export type PublicModuleBundler = Pick<ModuleBundler, 'getModuleBundle' | 'resolveModuleUri'>;
+export type PublicModuleBundler = Pick<ModuleBundler, 'getConfig' | 'getModuleBundle' | 'resolveModuleUri'>;
 export interface BundleRecord {
     imports?: BaseModuleReference[];
     dynamicImports?: BaseDynamicModuleReference[];

package/build/lwr-shim.d.ts

@@ -8,6 +8,14 @@ interface LwrShim {
     getResourceProviders(context: Partial<ProviderContext>): ResourceProvider[];
     getViewProviders(context: Partial<ProviderContext>): ViewProvider[];
     getViewTransformers(context: Partial<ProviderContext>): ViewTransformPlugin[];
+    env: GlobalThisEnvironment;
+}
+export interface GlobalThisEnvironment {
+    SSR: string | undefined;
+    basePath: string | undefined;
+    locale: string | undefined;
+    assetBasePath: string | undefined;
+    uiBasePath: string | undefined;
 }
 declare global {
     const LWR: LwrShim | undefined;

package/build/server.d.ts

@@ -34,7 +34,6 @@ export interface InternalAppServer<T extends ServerTypes> {
     initRoutes(): void;
     getRegexWildcard(): string;
 }
-export type PublicAppServer<T extends ServerTypes> = Pick<InternalAppServer<T>, 'use' | 'all' | 'get' | 'post' | 'getRegexWildcard'>;
 export type InternalAppServerOptions = {
     app?: ServerTypeImpl<ServerTypes>;
     basePath?: string;
@@ -82,6 +81,10 @@ export interface MiddlewareRequest {
      * Return true when the environment path parameter exists and is supported
      */
     validateEnvironmentRequest(config: NormalizedLwrGlobalConfig): boolean;
+    /**
+     * Return true when the api version path parameter exists and is supported
+     */
+    validateApiVersion(config: NormalizedLwrGlobalConfig): boolean;
     /**
      * Use the request parameters to resolve the runtime context(ie. environment and parameters)
      */

package/build/views.d.ts

@@ -23,12 +23,10 @@ export interface RenderingResult {
     renderedView: string;
     metadata?: RenderedViewMetadata;
     options?: RenderOptions;
+    cache?: CacheResponse;
 }
-export interface RenderedView {
+export interface RenderedView extends NormalizedRenderingResult {
     compiledView: CompiledView;
-    renderedView: string;
-    metadata: RenderedViewMetadata;
-    options: RenderOptions;
 }
 export interface CustomElementReference {
     tagName: string;
@@ -128,6 +126,9 @@ export interface ViewProvider {
     getView(viewId: ViewIdentity): Promise<CompiledView | undefined>;
 }
 export interface ViewTransformPluginContext {
+    config: {
+        cacheDir: string;
+    };
     view: View;
     viewParams: ViewParams;
     runtimeEnvironment: RuntimeEnvironment;
@@ -205,6 +206,12 @@ export interface SsrRequestContext {
     locale: string;
     basePath: string;
 }
+export interface SsrRequestOptions {
+    bundleSpecifier: string;
+    cacheDir: string;
+    host?: string;
+    requestDepth?: number;
+}
 export interface SsrDataResponse {
     props?: {
         [prop: string]: Json;

package/package.json

@@ -8,7 +8,7 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.12.0-alpha.2",
+    "version": "0.12.0-alpha.21",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -24,10 +24,10 @@
         "build/**/*.d.ts"
     ],
     "devDependencies": {
-        "chokidar": "^3.5.3"
+        "chokidar": "^3.6.0"
     },
     "engines": {
         "node": ">=18.0.0"
     },
-    "gitHead": "586a2aa659882483af9249dc3db7fe07bc842a25"
+    "gitHead": "3d77678ca2f568fcbe29efa2bf7e6f75778be50c"
 }