@lwrjs/types 0.9.0-alpha.1 → 0.9.0-alpha.11

package/build/config.d.ts

@@ -22,7 +22,7 @@ export interface NormalizedLwrRoute extends LwrRoute {
 export interface LwrErrorRoute extends LwrBaseRoute {
     status: 404 | 500;
 }
-export interface NormalizedLwrErrorRoute extends LwrBaseRoute {
+export interface NormalizedLwrErrorRoute extends LwrErrorRoute {
     bootstrap: NormalizedLwrAppBootstrapConfig;
 }
 export interface LwrAppBootstrapConfig {
@@ -86,7 +86,6 @@ export interface LwrGlobalConfig {
     resourceProviders?: ServiceConfig[];
     viewProviders?: ServiceConfig[];
     viewTransformers?: ServiceConfig[];
-    templateEngine?: string;
     routes?: LwrRoute[];
     errorRoutes?: LwrErrorRoute[];
     bundleConfig?: BundleConfig;
@@ -96,6 +95,7 @@ export interface LwrGlobalConfig {
 }
 export interface NormalizedLwrGlobalConfig extends Required<Omit<LwrGlobalConfig, 'lwc'>> {
     routes: NormalizedLwrRoute[];
+    errorRoutes: NormalizedLwrErrorRoute[];
     assets: AssetConfig[];
     lwrVersion: string;
     amdLoader: string;
@@ -111,6 +111,7 @@ export interface NormalizedLwrGlobalConfig extends Required<Omit<LwrGlobalConfig
 export interface StaticSiteGenerator {
     outputDir?: string;
     locales?: string[];
+    skipBaseDocumentGeneration?: boolean;
     _additionalRoutePaths?: string[];
     _additionalModules?: string[];
 }

package/build/index.d.ts

@@ -2,10 +2,8 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-/// <reference types="node" />
 import { EventEmitter } from 'events';
 import fs from 'fs';
-import { Server } from 'http';
 import { Readable } from 'stream';
 import { BundleConfig, EnvironmentConfig, HooksPlugin, LwrLockerConfig, NormalizedLwrErrorRoute, NormalizedLwrGlobalConfig, NormalizedLwrRoute, ResolverModuleRecord } from './config.js';
 import { AssetReference, CompiledView, PublicViewRegistry, ViewProvider, ViewRegistry, ViewTransformPlugin } from './views.js';
@@ -166,6 +164,7 @@ export interface ServerModeConfig {
 }
 export interface FeatureFlags {
     LEGACY_LOADER: boolean;
+    SSR_STATIC_BUNDLES: boolean;
 }
 export interface RuntimeEnvironment extends ServerModeConfig {
     apiVersion: string;
@@ -397,6 +396,7 @@ export declare type PublicResourceRegistry = Pick<ResourceRegistry, 'getResource
 export interface AssetRegistry {
     name: string;
     addAssetProviders(provider: AssetProvider[]): void;
+    addAssetTransformers(transformers: AssetTransformPlugin[]): 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>;
     getPublicApi(): PublicAssetRegistry;
@@ -494,7 +494,6 @@ export interface MetricsConfig {
 export interface ServerContext {
     appObserver: LwrAppObserver;
     appEmitter: LwrAppEmitter;
-    server: Server;
     compiler: Compiler;
     moduleRegistry: ModuleRegistry;
     moduleBundler: ModuleBundler;

package/build/server.d.ts

@@ -4,7 +4,7 @@ import { Application as ExpressApp } from 'express';
 import Koa, { Context } from 'koa';
 import http from 'http';
 import { Readable } from 'stream';
-import { RuntimeContext, RuntimeEnvironment } from './index';
+import type { NormalizedLwrGlobalConfig, RuntimeContext, RuntimeEnvironment } from './index.js';
 export declare type ServerTypes = 'koa' | 'express' | 'fs';
 export declare 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 declare type PublicAppServer<T extends ServerTypes> = Pick<InternalAppServer<T>, 'use' | 'all' | 'get' | 'post' | 'getRegexWildcard'>;
 export declare type InternalAppServerOptions = {
+    app?: ServerTypeImpl<ServerTypes>;
     basePath?: string;
 };
 export interface InternalAppServerConstructable {
@@ -59,6 +60,9 @@ export interface MiddlewareRequest {
     acceptsLanguages(): string[];
     get(field: string): string | undefined;
     cookie(name: string): string | undefined;
+    /**
+     * Return true if the request has a `json` query parameter
+     */
     hasJsonParam(): boolean;
     /**
      * Return JSON if:
@@ -66,20 +70,27 @@ export interface MiddlewareRequest {
      *      - the Accept header explicitly requests "application/json"
      */
     isJsonRequest(): boolean;
+    /**
+     * Return true if the request was initiated by static generation
+     */
+    isSiteGeneration(): boolean;
     /**
      * Return false when both Accept and JSON query param are applied, but do not semantically match
      */
     validateJsonRequest(): boolean;
     /**
-     * Use the Express Request parameters to create a Module/Resource Identifier and RuntimeEnvironment
+     * Return true when the environment path parameter exists and is supported
+     */
+    validateEnvironmentRequest(config: NormalizedLwrGlobalConfig): boolean;
+    /**
+     * Use the request parameters to resolve the runtime context(ie. environment and parameters)
      */
     getRuntimeContext(defaultRuntimeEnvironment: RuntimeEnvironment): RuntimeContext;
-    isSiteGeneration(): boolean;
 }
 export interface MiddlewareResponse {
     set(header: any): void;
     setHeader(name: string, value: string | string[]): void;
-    setMetadata(metadata: any): void;
+    setSiteGenerationMetadata(metadata: any): void;
     status(status: number): MiddlewareResponse;
     send(object: any): void;
     sendStatus(httpCode: number): void;

package/build/views.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { RouteHandlerFunction, RouteHandlerView, View } from './config.js';
-import { AssetSource, AssetUri, Endpoints, FlattenedModuleGraphs, ImportMetadata, Json, LwrStringBuilder, ResourceDefinition, RuntimeEnvironment, RuntimeParams, Specifier, TransformPluginContext } from './index.js';
+import { AssetSource, AssetUri, Endpoints, FlattenedModuleGraphs, ImportMetadata, Json, LwrErrorRoute, LwrRoute, LwrStringBuilder, ResourceDefinition, RuntimeEnvironment, RuntimeParams, Specifier, TransformPluginContext } from './index.js';
 export declare type ViewIdentity = Pick<View, 'rootComponent' | 'contentTemplate'>;
 export interface ViewSource {
     name: string;
@@ -82,6 +82,7 @@ export interface LinkedViewDefinition {
     renderedView: string;
     viewRecord: RenderedViewRecord;
     immutable: boolean;
+    cache?: CacheResponse;
 }
 interface ViewRequestQs {
     [key: string]: undefined | string | string[];
@@ -136,6 +137,7 @@ declare type ViewPluginLinkHook = (builder: LwrStringBuilder, viewContext: ViewT
 declare type ViewPluginLinkHookReturn = void | null | undefined | false | LwrStringBuilder | {
     builder?: LwrStringBuilder;
     context?: TransformPluginContext;
+    cache?: CacheResponse;
 };
 declare type ViewPluginOptimizeHook = (code: string, assetSource: AssetSource, context?: TransformPluginContext) => Promise<ViewPluginOptimizeHookReturn>;
 declare type ViewPluginOptimizeHookReturn = null | undefined | false | string | {
@@ -174,6 +176,7 @@ export declare type ViewModuleResourceContext = {
 };
 export interface ViewRegistry {
     addViewProviders(providers: ViewProvider[]): void;
+    addViewTransformers(transformers: ViewTransformPlugin[]): void;
     initializeViewProviders(): Promise<void[]>;
     getView(viewId: ViewIdentity, skipCaching?: boolean): Promise<CompiledView>;
     getViewDefinition<R extends RuntimeEnvironment>(view: View, viewParams: ViewParams, runtimeEnvironment: R, runtimeParams?: RuntimeParams, renderOptions?: RenderOptions): Promise<LinkedViewDefinition>;
@@ -181,6 +184,11 @@ export interface ViewRegistry {
     getPublicApi(): PublicViewRegistry;
 }
 export declare type PublicViewRegistry = Pick<ViewRegistry, 'getView' | 'getViewDefinition'>;
+export interface ViewHandler {
+    getViewContent(viewRequest: ViewRequest, route: LwrRoute | LwrErrorRoute, runtimeEnvironment: RuntimeEnvironment, runtimeParams: RuntimeParams): Promise<ViewResponse>;
+    getViewJson(viewRequest: ViewRequest, route: LwrRoute | LwrErrorRoute, runtimeEnvironment: RuntimeEnvironment, runtimeParams: RuntimeParams): Promise<ViewResponse>;
+    getViewConfiguration(viewRequest: ViewRequest, route: LwrRoute | LwrErrorRoute, runtimeEnvironment: RuntimeEnvironment, runtimeParams: RuntimeParams): Promise<ViewResponse | undefined>;
+}
 export interface SsrRequestContext {
     props: Json;
     params: {
@@ -201,6 +209,7 @@ export interface PageDataResponse {
             fetchpriority?: 'high' | 'low' | 'auto';
         }[];
     };
+    cache?: CacheResponse;
 }
 export {};
 //# sourceMappingURL=views.d.ts.map

package/package.json

@@ -8,7 +8,7 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.9.0-alpha.1",
+    "version": "0.9.0-alpha.11",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -26,5 +26,5 @@
     "engines": {
         "node": ">=14.15.4 <19"
     },
-    "gitHead": "7a32c273de67d937fcbcd42293d9e251ed01f123"
+    "gitHead": "3cb1275b364ae7373c1868c79e6082a122dbef9c"
 }