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

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';
+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';
 export interface View {
     id: string;
     rootComponent?: string;
@@ -44,6 +44,8 @@ export interface LwrAppBootstrapConfig {
     mixedMode?: boolean;
     module?: string | undefined;
     preloadModules?: string[];
+    lwrVersion?: string;
+    lwcVersion?: string;
 }
 export interface NormalizedLwrAppBootstrapConfig extends Required<Omit<LwrAppBootstrapConfig, 'module'>> {
     services: BootstrapService[];
@@ -62,6 +64,8 @@ export interface NormalizedRouteHandlersConfig {
 export interface LocalizedViewRequest extends ViewRequest {
     locale?: string;
     basePath?: string;
+    assetBasePath?: string;
+    uiBasePath?: string;
 }
 export type RouteHandlerFunction = (viewRequest: LocalizedViewRequest, handlerContext: HandlerContext, routeHandlerOptions?: any) => Promise<RouteHandlerViewResponse> | RouteHandlerViewResponse;
 export interface ResourcePaths {

package/build/index.d.ts

@@ -174,6 +174,7 @@ export interface FeatureFlags extends Record<string, boolean | string | undefine
     SSR_STATIC_BUNDLES?: boolean;
     SSR_WITH_CSR_FALLBACK?: boolean;
     EXPERIMENTAL_UNVERSIONED_ALIASES?: boolean;
+    ENABLE_NONCE?: boolean;
 }
 export interface RuntimeEnvironment extends ServerModeConfig {
     apiVersion: string;
@@ -313,6 +314,7 @@ export interface BundleDefinition extends ModuleId {
     map?: any;
     bundleRecord: BundleRecord;
     src?: string;
+    integrity?: string;
 }
 export interface ProviderAppConfig {
     modules: ResolverModuleRecord[];
@@ -365,6 +367,7 @@ export interface ResourceDefinition {
     specifier?: string;
     type: ResourceType;
     src?: string;
+    entry?: string;
     inline?: boolean;
     async?: boolean;
     defer?: boolean;
@@ -372,6 +375,8 @@ export interface ResourceDefinition {
     content?: string;
     stream?: () => Readable;
     isPreload?: boolean;
+    version?: string;
+    integrity?: string;
 }
 export interface AssetMetadata {
     assetReferences?: AssetReference[];
@@ -512,11 +517,8 @@ export interface ClientBootstrapConfig {
     imports?: ImportMetadataImports;
     index?: ImportMetadataIndex;
     metricsConfig?: MetricsConfig;
-    /**
-    /* @deprecated for mapping endpoint syntax
-    /* Import map for the loader to resolve modules, defaults to a "lwr-importmap" script tag
-    */
     importMappings?: object;
+    env?: any;
 }
 export interface Endpoints {
     uris: Record<string, string>;
@@ -623,6 +625,16 @@ export interface LwrStringBuilder {
     toString(): string;
     original: string;
 }
+export interface DecisionTree<Artifact extends SiteArtifact> {
+    /**
+     * Insert an artifact into the tree based on a path of decisions
+     */
+    insert(siteArtifactId: string, artifact: Artifact, debug?: boolean, localeFallbacks?: Record<string, string[]>): void;
+    /**
+     * Retrieve an artifact from the tree based on a path of decisions
+     */
+    find(siteArtifactId: string | Partial<AbstractModuleId>, debug?: boolean, localeId?: string): Artifact | undefined;
+}
 export interface SiteMetadata {
     /**
      * Get the path that all site metadata is relative to
@@ -654,6 +666,14 @@ export interface SiteMetadata {
      * @returns
      */
     persistSiteMetadata(): Promise<void>;
+    /**
+     * Get get decision tree to figure out the best site bundle to use.
+     */
+    getSiteBundlesDecisionTree(): DecisionTree<SiteBundle>;
+    /**
+     * Get get decision tree to figure out the best site resource to use.
+     */
+    getSiteResourcesDecisionTree(): DecisionTree<SiteResource>;
 }
 export interface SiteBundles {
     bundles: Record<string, SiteBundle>;
@@ -667,6 +687,7 @@ export interface SiteAssets {
 export interface SiteArtifact {
     path: string;
     mimeType?: string;
+    integrity?: string;
 }
 export interface SiteResource extends SiteArtifact {
     inline?: boolean;

package/build/lwr-shim.d.ts

@@ -1,4 +1,4 @@
-import type { AssetProvider, HooksPlugin, ModuleProvider, ProviderContext, ResourceProvider, ViewProvider, ViewTransformPlugin } from './index';
+import type { AssetProvider, HooksPlugin, ModuleProvider, ProviderContext, ResourceProvider, ViewProvider, ViewTransformPlugin } from './index.js';
 interface LwrShim {
     LWC_VERSION: string;
     LEGACY_LOADER: boolean;

package/build/serviceAPI/appMetadata/appMetadata.d.ts

@@ -1,5 +1,5 @@
 export type AppMetadata = {
-    appId?: string;
+    appId?: string | null;
     bootstrapModule: string;
     rootComponent?: string;
     rootComponents?: string[];

package/build/serviceAPI/loaderPlugins/loaderPlugins.d.ts

@@ -1,4 +1,4 @@
-import type { ImportMetadata } from '../..';
+import type { ImportMetadata } from '../../index.js';
 type ResolveParams = {
     parentUrl: string;
 };

package/build/serviceAPI/serviceAPI.d.ts

@@ -1,16 +1,28 @@
-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 DataServiceAPI {
+import type { ServerData } from '../index.js';
+import type { RegisterLoaderHooks } from './loaderPlugins/loaderPlugins.js';
+import type { RegisterHandleStaleModuleHook } from './handleStaleModule/handleStaleModule.js';
+import type { AppMetadata } from './appMetadata/appMetadata.js';
+export type ServerDataCallbackParams = {
     serverData: ServerData;
+};
+export interface ServerDataCallback {
+    (params: ServerDataCallbackParams): void | null;
 }
-export interface ServiceAPI extends DataServiceAPI {
+interface RegisterServerDataCallback {
+    (hook: ServerDataCallback): void;
+}
+export interface ServiceAPI {
     addLoaderPlugin: NoOp | RegisterLoaderHooks;
     handleStaleModule: RegisterHandleStaleModuleHook;
+    addServerDataCallback: RegisterServerDataCallback;
     appMetadata: AppMetadata;
 }
+export interface ServerServiceAPI {
+    addLoaderPlugin: NoOp | RegisterLoaderHooks;
+    addServerDataCallback: RegisterServerDataCallback;
+}
 export interface NoOp {
     (): void;
 }
+export {};
 //# sourceMappingURL=serviceAPI.d.ts.map

package/build/views.d.ts

@@ -16,7 +16,7 @@ export interface CompiledView extends ViewSource {
     properties?: {
         [key: string]: unknown;
     };
-    render: (context?: any) => Promise<RenderingResult>;
+    render: (context: any, runtimeEnvironment: RuntimeEnvironment) => Promise<RenderingResult>;
 }
 export type NormalizedRenderingResult = Required<RenderingResult>;
 export interface RenderingResult {
@@ -74,6 +74,7 @@ export interface RenderedViewRecord {
     customElements?: CustomElementRecord[];
     endpoints?: Endpoints;
     importMetadata?: ImportMetadata;
+    moduleResources: ResourceDefinition[];
     bootstrapModule?: {
         specifier: Specifier;
         flatGraph: FlattenedModuleGraphs;
@@ -85,6 +86,7 @@ export interface LinkedViewDefinition {
     viewRecord: RenderedViewRecord;
     immutable: boolean;
     cache?: CacheResponse;
+    nonce?: string;
 }
 export interface ViewRequestQs {
     [key: string]: undefined | string | string[];
@@ -109,6 +111,7 @@ export interface ViewResponse {
     metadata?: {
         viewDefinition?: LinkedViewDefinition;
     };
+    locale?: string;
 }
 export type RouteHandlerViewResponse = ViewDefinitionResponse | ViewResponse;
 export interface ViewDefinitionResponse {
@@ -119,6 +122,7 @@ export interface ViewDefinitionResponse {
     cache?: CacheResponse;
     headers?: Record<string, string>;
     cookie?: 'wip';
+    locale?: string;
 }
 export interface ViewProvider {
     name: string;
@@ -175,11 +179,14 @@ export interface ViewPageContext {
     url: string;
     basePath?: string;
     locale?: string;
+    nonce?: string;
 }
 export type ViewModuleResourceContext = {
     isPreload?: boolean;
     isSSR?: boolean;
     async?: boolean;
+    nonce?: string;
+    integrity?: string;
 };
 export interface ViewRegistry {
     addViewProviders(providers: ViewProvider[]): void;
@@ -212,17 +219,28 @@ export interface SsrRequestOptions {
     host?: string;
     requestDepth?: number;
 }
+export type MetaTag = {
+    name?: string;
+    httpEquiv?: string;
+    content?: string;
+};
+export type LinkTag = {
+    href: string;
+    as?: string;
+    rel?: string;
+    fetchpriority?: 'high' | 'low' | 'auto';
+};
 export interface SsrDataResponse {
     props?: {
         [prop: string]: Json;
     };
     markup?: {
-        links?: {
-            href: string;
-            as?: string;
-            rel?: string;
-            fetchpriority?: 'high' | 'low' | 'auto';
+        title?: string;
+        meta?: MetaTag[];
+        scripts?: {
+            body: string;
         }[];
+        links?: LinkTag[];
     };
     cache?: CacheResponse;
 }

package/package.json

@@ -8,7 +8,7 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.13.0-alpha.2",
+    "version": "0.13.0-alpha.21",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -29,5 +29,5 @@
     "engines": {
         "node": ">=18.0.0"
     },
-    "gitHead": "3ae1051ef1eb282f9c1fb54f6aab44ab5ba48480"
+    "gitHead": "d272dcd07881fa469ee73bd28d2f30f99957e122"
 }