@lwrjs/types 0.7.0-alpha.9 → 0.7.0

package/build/config.d.ts

@@ -40,7 +40,10 @@ export interface LwrLockerConfig {
     trustedComponents?: string[];
     clientOnly?: boolean;
 }
-export declare type RouteHandlerFunction = (viewRequest: ViewRequest, handlerContext: HandlerContext) => Promise<RouteHandlerViewResponse>;
+export interface LocalizedViewRequest extends ViewRequest {
+    locale?: string;
+}
+export declare type RouteHandlerFunction = (viewRequest: LocalizedViewRequest, handlerContext: HandlerContext) => Promise<RouteHandlerViewResponse>;
 export interface ResourcePaths {
     rootDir: string;
     assets: AssetConfig[];

package/build/index.d.ts

@@ -3,9 +3,11 @@ 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, RouteHandlerFunction, RouteHandlerView, View } from './config.js';
+import { BundleConfig, EnvironmentConfig, HooksPlugin, LwrLockerConfig, NormalizedLwrErrorRoute, NormalizedLwrGlobalConfig, NormalizedLwrRoute, ResolverModuleRecord } from './config.js';
+import { AssetReference, CompiledView, PublicViewRegistry, ViewProvider, ViewRegistry, ViewTransformPlugin } from './views.js';
 export * from './config.js';
 export * from './server.js';
+export * from './views.js';
 export * from './serviceAPI/serviceAPI.js';
 export * from './serviceAPI/loaderPlugins/loaderPlugins.js';
 export * from './serviceAPI/handleStaleModule/handleStaleModule.js';
@@ -170,7 +172,7 @@ export interface RuntimeEnvironment extends ServerModeConfig {
 export interface SourceMapRuntimeEnvironment extends RuntimeEnvironment {
     sourceMapUrl?: string;
 }
-export declare type RuntimeParams = Record<string, string | number | boolean | null | undefined>;
+export declare type RuntimeParams = Record<string, string | number | boolean | null | undefined | Record<string, string>>;
 export interface ModuleIdentity {
     signature: string;
     moduleId: AbstractModuleId;
@@ -326,13 +328,6 @@ export interface ResourceDefinition {
     stream?: Readable;
     isPreload?: boolean;
 }
-export interface AssetReference {
-    url: string;
-    location: {
-        startOffset: number;
-        endOffset: number;
-    };
-}
 export interface AssetMetadata {
     assetReferences?: AssetReference[];
 }
@@ -360,7 +355,7 @@ export interface AssetProvider {
     name: string;
     getAsset(fileAssetPath: string): Promise<AssetSource | undefined>;
 }
-declare type TransformPluginContext = Record<string, any>;
+export declare type TransformPluginContext = Record<string, any>;
 declare type AssetPluginTransformHook = (code: string | Buffer, assetSource: AssetSource, context?: TransformPluginContext) => Promise<AssetPluginTransformHookReturn>;
 declare type AssetPluginTransformHookReturn = null | undefined | false | string | Buffer | {
     code: string | Buffer;
@@ -385,180 +380,6 @@ export interface AssetTransformHooks {
 export interface AssetTransformPlugin extends Partial<AssetTransformHooks> {
     name: string;
 }
-export declare type ViewIdentity = Pick<View, 'rootComponent' | 'contentTemplate'>;
-export interface ViewSource {
-    name: string;
-    slug: string;
-    ownHash: string;
-    originalSource: string;
-    filePath: string;
-}
-export interface CompiledView extends ViewSource {
-    viewId: ViewIdentity;
-    layoutTemplate?: string;
-    immutable?: boolean;
-    properties?: {
-        [key: string]: unknown;
-    };
-    render: (context?: any) => Promise<RenderingResult>;
-}
-export declare type NormalizedRenderingResult = Required<RenderingResult>;
-export interface RenderingResult {
-    renderedView: string;
-    metadata?: RenderedViewMetadata;
-    options?: RenderOptions;
-}
-export interface RenderedView {
-    compiledView: CompiledView;
-    renderedView: string;
-    metadata: RenderedViewMetadata;
-    options: RenderOptions;
-}
-export interface CustomElementReference {
-    tagName: string;
-    props?: {
-        [name: string]: string;
-    };
-    children?: CustomElementReference[];
-    location?: {
-        startOffset: number;
-        endOffset: number;
-    };
-}
-export interface RenderedViewMetadata {
-    customElements: CustomElementReference[];
-    assetReferences: AssetReference[];
-}
-export interface RenderedAssetReference {
-    url: string;
-    tagName?: string;
-    override?: AssetUri;
-}
-export interface AssetReference extends RenderedAssetReference {
-    importer?: string;
-    location: {
-        startOffset: number;
-        endOffset: number;
-    };
-}
-export interface LinkedViewDefinitionMetaData {
-    customElements: string[];
-    assetReferences: RenderedAssetReference[];
-}
-export interface CustomElementRecord {
-    elementName: string;
-    flatGraph: FlattenedModuleGraphs;
-}
-export interface RenderedViewRecord {
-    resources?: ResourceDefinition[];
-    assetReferences?: RenderedAssetReference[];
-    customElements?: CustomElementRecord[];
-    endpoints?: Endpoints;
-    importMetadata?: ImportMetadata;
-    bootstrapModule?: {
-        specifier: Specifier;
-        flatGraph: FlattenedModuleGraphs;
-        resources?: ResourceDefinition[];
-    };
-}
-export interface LinkedViewDefinition {
-    renderedView: string;
-    viewRecord: RenderedViewRecord;
-    immutable: boolean;
-}
-interface ViewRequestQs {
-    [key: string]: undefined | string | string[];
-}
-export interface ViewRequest {
-    url: string;
-    requestPath: string;
-    params?: any;
-    query?: ViewRequestQs;
-    routeHandlerFunction?: RouteHandlerFunction;
-}
-export interface CacheResponse {
-    ttl?: string | number;
-}
-export interface ViewResponse {
-    status?: number;
-    body: Buffer | string | boolean | Json;
-    cache?: CacheResponse;
-    headers?: Record<string, string>;
-    cookie?: 'wip';
-    metadata?: {
-        viewDefinition?: LinkedViewDefinition;
-    };
-}
-export declare type RouteHandlerViewResponse = ViewDefinitionResponse | ViewResponse;
-export interface ViewDefinitionResponse {
-    status?: number;
-    view: RouteHandlerView;
-    viewParams: ViewParams;
-    renderOptions?: RenderOptions;
-    cache?: CacheResponse;
-    headers?: Record<string, string>;
-    cookie?: 'wip';
-}
-export interface ViewProvider {
-    name: string;
-    initialize(): Promise<void>;
-    getView(viewId: ViewIdentity): Promise<CompiledView | undefined>;
-}
-export interface ViewTranformPluginContext {
-    view: View;
-    viewParams: ViewParams;
-    runtimeEnvironment: RuntimeEnvironment;
-    runtimeParams: RuntimeParams;
-    renderOptions: Required<RenderOptions>;
-    contentIds: {
-        lwrResourcesId: string;
-    };
-    importer?: string;
-}
-declare type ViewPluginLinkHook = (builder: LwrStringBuilder, viewContext: ViewTranformPluginContext, viewMetadata: RenderedViewMetadata, context?: TransformPluginContext) => Promise<ViewPluginLinkHookReturn>;
-declare type ViewPluginLinkHookReturn = void | null | undefined | false | LwrStringBuilder | {
-    builder?: LwrStringBuilder;
-    context?: TransformPluginContext;
-};
-declare type ViewPluginOptimizeHook = (code: string, assetSource: AssetSource, context?: TransformPluginContext) => Promise<ViewPluginOptimizeHookReturn>;
-declare type ViewPluginOptimizeHookReturn = null | undefined | false | string | {
-    code: string;
-    map?: any;
-    context?: TransformPluginContext;
-};
-export interface ViewTransformHooks {
-    link: ViewPluginLinkHook;
-    optimize: ViewPluginOptimizeHook;
-}
-export interface ViewTransformPlugin extends Partial<ViewTransformHooks> {
-    name: string;
-}
-export declare type ViewParams = Record<string, Json>;
-export interface ViewInfo {
-    id: string;
-    url: string;
-    configAsSrc: boolean;
-}
-export interface RenderOptions {
-    skipMetadataCollection?: boolean;
-    freezeAssets?: boolean;
-    skipCaching?: boolean;
-    viewParamCacheKey?: Json;
-}
-export interface ViewPageContext {
-    id: string;
-    title?: string;
-    url: string;
-}
-export interface ViewRegistry {
-    addViewProviders(providers: ViewProvider[]): 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>;
-    hasViewDefinition<R extends RuntimeEnvironment>(view: View, viewParams: ViewParams, runtimeEnvironment: R, runtimeParams?: RuntimeParams, renderOptions?: RenderOptions): boolean;
-    getPublicApi(): PublicViewRegistry;
-}
-export declare type PublicViewRegistry = Pick<ViewRegistry, 'getView' | 'getViewDefinition'>;
 export interface ResourceRegistry {
     name: string;
     addResourceProviders(provider: ResourceProvider[]): void;
@@ -633,11 +454,7 @@ export interface ClientBootstrapConfig {
     preloadModules?: string[];
     rootComponent?: string;
     rootComponents?: string[];
-    rootProperties?: {
-        [specifier: string]: {
-            [key: string]: string;
-        };
-    };
+    ssrProps?: Json;
     customInit?: Function;
     onError?: Function;
     baseUrl?: string;

package/build/index.js

@@ -1,5 +1,6 @@
 export * from './config.js';
 export * from './server.js';
+export * from './views.js';
 // -- ServiceAPI --------------------------------
 export * from './serviceAPI/serviceAPI.js';
 export * from './serviceAPI/loaderPlugins/loaderPlugins.js';

package/build/views.d.ts

@@ -0,0 +1,193 @@
+/// <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';
+export declare type ViewIdentity = Pick<View, 'rootComponent' | 'contentTemplate'>;
+export interface ViewSource {
+    name: string;
+    slug: string;
+    ownHash: string;
+    originalSource: string;
+    filePath: string;
+}
+export interface CompiledView extends ViewSource {
+    viewId: ViewIdentity;
+    layoutTemplate?: string;
+    immutable?: boolean;
+    properties?: {
+        [key: string]: unknown;
+    };
+    render: (context?: any) => Promise<RenderingResult>;
+}
+export declare type NormalizedRenderingResult = Required<RenderingResult>;
+export interface RenderingResult {
+    renderedView: string;
+    metadata?: RenderedViewMetadata;
+    options?: RenderOptions;
+}
+export interface RenderedView {
+    compiledView: CompiledView;
+    renderedView: string;
+    metadata: RenderedViewMetadata;
+    options: RenderOptions;
+}
+export interface CustomElementReference {
+    tagName: string;
+    props?: {
+        [name: string]: string;
+    };
+    children?: CustomElementReference[];
+    location?: {
+        startOffset: number;
+        endOffset: number;
+    };
+}
+export interface RenderedViewMetadata {
+    customElements: CustomElementReference[];
+    assetReferences: AssetReference[];
+}
+export interface RenderedAssetReference {
+    url: string;
+    tagName?: string;
+    override?: AssetUri;
+}
+export interface AssetReference extends RenderedAssetReference {
+    importer?: string;
+    location: {
+        startOffset: number;
+        endOffset: number;
+    };
+}
+export interface LinkedViewDefinitionMetaData {
+    customElements: string[];
+    assetReferences: RenderedAssetReference[];
+}
+export interface CustomElementRecord {
+    elementName: string;
+    flatGraph: FlattenedModuleGraphs;
+}
+export interface RenderedViewRecord {
+    resources?: ResourceDefinition[];
+    assetReferences?: RenderedAssetReference[];
+    customElements?: CustomElementRecord[];
+    endpoints?: Endpoints;
+    importMetadata?: ImportMetadata;
+    bootstrapModule?: {
+        specifier: Specifier;
+        flatGraph: FlattenedModuleGraphs;
+        resources?: ResourceDefinition[];
+    };
+}
+export interface LinkedViewDefinition {
+    renderedView: string;
+    viewRecord: RenderedViewRecord;
+    immutable: boolean;
+}
+interface ViewRequestQs {
+    [key: string]: undefined | string | string[];
+}
+export interface ViewRequest {
+    url: string;
+    requestPath: string;
+    params?: any;
+    query?: ViewRequestQs;
+    routeHandlerFunction?: RouteHandlerFunction;
+}
+export interface CacheResponse {
+    ttl?: string | number;
+}
+export interface ViewResponse {
+    status?: number;
+    body: Buffer | string | boolean | Json;
+    cache?: CacheResponse;
+    headers?: Record<string, string>;
+    cookie?: 'wip';
+    metadata?: {
+        viewDefinition?: LinkedViewDefinition;
+    };
+}
+export declare type RouteHandlerViewResponse = ViewDefinitionResponse | ViewResponse;
+export interface ViewDefinitionResponse {
+    status?: number;
+    view: RouteHandlerView;
+    viewParams: ViewParams;
+    renderOptions?: RenderOptions;
+    cache?: CacheResponse;
+    headers?: Record<string, string>;
+    cookie?: 'wip';
+}
+export interface ViewProvider {
+    name: string;
+    initialize(): Promise<void>;
+    getView(viewId: ViewIdentity): Promise<CompiledView | undefined>;
+}
+export interface ViewTranformPluginContext {
+    view: View;
+    viewParams: ViewParams;
+    runtimeEnvironment: RuntimeEnvironment;
+    runtimeParams: RuntimeParams;
+    renderOptions: Required<RenderOptions>;
+    contentIds: {
+        lwrResourcesId: string;
+    };
+    importer?: string;
+}
+declare type ViewPluginLinkHook = (builder: LwrStringBuilder, viewContext: ViewTranformPluginContext, viewMetadata: RenderedViewMetadata, context?: TransformPluginContext) => Promise<ViewPluginLinkHookReturn>;
+declare type ViewPluginLinkHookReturn = void | null | undefined | false | LwrStringBuilder | {
+    builder?: LwrStringBuilder;
+    context?: TransformPluginContext;
+};
+declare type ViewPluginOptimizeHook = (code: string, assetSource: AssetSource, context?: TransformPluginContext) => Promise<ViewPluginOptimizeHookReturn>;
+declare type ViewPluginOptimizeHookReturn = null | undefined | false | string | {
+    code: string;
+    map?: any;
+    context?: TransformPluginContext;
+};
+export interface ViewTransformHooks {
+    link: ViewPluginLinkHook;
+    optimize: ViewPluginOptimizeHook;
+}
+export interface ViewTransformPlugin extends Partial<ViewTransformHooks> {
+    name: string;
+}
+export declare type ViewParams = Record<string, Json>;
+export interface ViewInfo {
+    id: string;
+    url: string;
+    configAsSrc: boolean;
+}
+export interface RenderOptions {
+    skipMetadataCollection?: boolean;
+    freezeAssets?: boolean;
+    skipCaching?: boolean;
+    viewParamCacheKey?: Json;
+}
+export interface ViewPageContext {
+    id: string;
+    title?: string;
+    url: string;
+}
+export interface ViewRegistry {
+    addViewProviders(providers: ViewProvider[]): 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>;
+    hasViewDefinition<R extends RuntimeEnvironment>(view: View, viewParams: ViewParams, runtimeEnvironment: R, runtimeParams?: RuntimeParams, renderOptions?: RenderOptions): boolean;
+    getPublicApi(): PublicViewRegistry;
+}
+export declare type PublicViewRegistry = Pick<ViewRegistry, 'getView' | 'getViewDefinition'>;
+export interface PropsRequestContext {
+    props: Json;
+    params: {
+        [key: string]: string;
+    };
+    query: {
+        [key: string]: string;
+    };
+    locale: string;
+    fetch: Function;
+}
+export interface PropsResponse {
+    props: Json;
+}
+export {};
+//# sourceMappingURL=views.d.ts.map

package/build/views.js

@@ -0,0 +1,3 @@
+export {};
+// END types for SSR data
+//# sourceMappingURL=views.js.map

package/package.json

@@ -8,7 +8,7 @@
         "build": "tsc -b"
     },
     "type": "module",
-    "version": "0.7.0-alpha.9",
+    "version": "0.7.0",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -25,7 +25,7 @@
         "build/**/*.d.ts"
     ],
     "engines": {
-        "node": ">=14.15.4 <17"
+        "node": ">=14.15.4 <19"
     },
-    "gitHead": "522665298cc74f1898da6ed018fa72504bd72645"
+    "gitHead": "c6dcb52144a8da80170e30d49a87e29d2da30f9b"
 }