@lwrjs/types 0.11.0-alpha.3 → 0.11.0-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/config.d.ts +11 -2
- package/build/index.d.ts +4 -2
- package/build/views.d.ts +4 -4
- package/package.json +2 -2
package/build/config.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import type { AssetProvider, AssetTransformPlugin, BundleProvider, CacheResponse
|
|
|
2
2
|
export interface View {
|
|
3
3
|
id: string;
|
|
4
4
|
rootComponent?: string;
|
|
5
|
-
contentTemplate?: string
|
|
5
|
+
contentTemplate?: string | Record<string, string>;
|
|
6
6
|
layoutTemplate?: string;
|
|
7
7
|
bootstrap?: LwrAppBootstrapConfig;
|
|
8
8
|
}
|
|
@@ -107,11 +107,12 @@ export interface LwrGlobalConfig {
|
|
|
107
107
|
staticSiteGenerator?: StaticSiteGenerator;
|
|
108
108
|
locker?: LwrLockerConfig;
|
|
109
109
|
uriTransformers?: ServiceConfig[];
|
|
110
|
+
i18n?: I18NConfig;
|
|
110
111
|
}
|
|
111
112
|
type RequiredPick<T, K extends keyof T> = {
|
|
112
113
|
[P in K]-?: T[P];
|
|
113
114
|
};
|
|
114
|
-
export type OnStartConfig = RequiredPick<LwrGlobalConfig, '
|
|
115
|
+
export type OnStartConfig = RequiredPick<LwrGlobalConfig, 'basePath' | 'i18n' | 'routes'>;
|
|
115
116
|
export interface BuildOptions {
|
|
116
117
|
target?: string;
|
|
117
118
|
input?: string;
|
|
@@ -140,6 +141,7 @@ export interface NormalizedLwrGlobalConfig extends Required<Omit<LwrGlobalConfig
|
|
|
140
141
|
assetTransformers: ServiceEntry[];
|
|
141
142
|
uriTransformers: ServiceEntry[];
|
|
142
143
|
lwc: NormalizedLwcConfig;
|
|
144
|
+
i18n: I18NConfig;
|
|
143
145
|
}
|
|
144
146
|
export interface StaticSiteGenerator {
|
|
145
147
|
outputDir?: string;
|
|
@@ -276,6 +278,13 @@ export interface HooksPlugin {
|
|
|
276
278
|
}
|
|
277
279
|
export interface Locale {
|
|
278
280
|
id: string;
|
|
281
|
+
fallback?: string;
|
|
279
282
|
}
|
|
283
|
+
export interface I18NConfig {
|
|
284
|
+
defaultLocale: string;
|
|
285
|
+
locales: Locale[];
|
|
286
|
+
uriPattern?: UriPattern;
|
|
287
|
+
}
|
|
288
|
+
export type UriPattern = undefined | 'path-prefix' | 'query-param';
|
|
280
289
|
export {};
|
|
281
290
|
//# sourceMappingURL=config.d.ts.map
|
package/build/index.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ import type { WatchOptions } from 'chokidar';
|
|
|
6
6
|
import type { EventEmitter } from 'events';
|
|
7
7
|
import type fs from 'fs';
|
|
8
8
|
import type { Readable } from 'stream';
|
|
9
|
-
import type { BundleConfig, EnvironmentConfig, HooksPlugin, LwrLockerConfig, NormalizedLwrErrorRoute, NormalizedLwrGlobalConfig, NormalizedLwrRoute, ResolverModuleRecord, BundleConfigOverrides, RouteHandlers, AssetConfig } from './config.js';
|
|
9
|
+
import type { BundleConfig, EnvironmentConfig, HooksPlugin, LwrLockerConfig, NormalizedLwrErrorRoute, NormalizedLwrGlobalConfig, NormalizedLwrRoute, ResolverModuleRecord, BundleConfigOverrides, RouteHandlers, AssetConfig, I18NConfig } from './config.js';
|
|
10
10
|
import type { AssetReference, CompiledView, PublicViewRegistry, ViewProvider, ViewRegistry, ViewTransformPlugin } from './views.js';
|
|
11
11
|
export * from './lwr-shim.js';
|
|
12
12
|
export * from './config.js';
|
|
@@ -170,6 +170,7 @@ export interface FeatureFlags extends Record<string, boolean | undefined> {
|
|
|
170
170
|
LEGACY_LOADER?: boolean;
|
|
171
171
|
SSR_SANDBOX_WORKER?: boolean;
|
|
172
172
|
SSR_STATIC_BUNDLES?: boolean;
|
|
173
|
+
SSR_WITH_CSR_FALLBACK?: boolean;
|
|
173
174
|
EXPERIMENTAL_UNVERSIONED_ALIASES?: boolean;
|
|
174
175
|
}
|
|
175
176
|
export interface RuntimeEnvironment extends ServerModeConfig {
|
|
@@ -317,6 +318,7 @@ export interface ProviderAppConfig {
|
|
|
317
318
|
environment?: EnvironmentConfig;
|
|
318
319
|
bundleConfig: BundleConfig;
|
|
319
320
|
assets: AssetConfig[];
|
|
321
|
+
i18n: I18NConfig;
|
|
320
322
|
}
|
|
321
323
|
export interface ProviderContext {
|
|
322
324
|
appObserver: Pick<LwrAppObserver, 'onModuleDefinitionChange' | 'onModuleSourceChange' | 'onAssetSourceChange' | 'onViewSourceChange'>;
|
|
@@ -487,7 +489,7 @@ export interface ClientBootstrapConfig {
|
|
|
487
489
|
preloadModules?: string[];
|
|
488
490
|
rootComponent?: string;
|
|
489
491
|
rootComponents?: string[];
|
|
490
|
-
|
|
492
|
+
serverData?: Json;
|
|
491
493
|
customInit?: Function;
|
|
492
494
|
onError?: Function;
|
|
493
495
|
baseUrl?: string;
|
package/build/views.d.ts
CHANGED
|
@@ -44,7 +44,7 @@ export interface CustomElementReference {
|
|
|
44
44
|
export interface RenderedViewMetadata {
|
|
45
45
|
customElements: CustomElementReference[];
|
|
46
46
|
assetReferences: AssetReference[];
|
|
47
|
-
|
|
47
|
+
serverData?: {
|
|
48
48
|
[prop: string]: Json;
|
|
49
49
|
};
|
|
50
50
|
}
|
|
@@ -124,7 +124,7 @@ export interface ViewDefinitionResponse {
|
|
|
124
124
|
export interface ViewProvider {
|
|
125
125
|
name: string;
|
|
126
126
|
initialize(): Promise<void>;
|
|
127
|
-
getView(viewId: ViewIdentity): Promise<CompiledView | undefined>;
|
|
127
|
+
getView(viewId: ViewIdentity, runtimeParams: RuntimeParams): Promise<CompiledView | undefined>;
|
|
128
128
|
}
|
|
129
129
|
export interface ViewTransformPluginContext {
|
|
130
130
|
view: View;
|
|
@@ -181,7 +181,7 @@ export interface ViewRegistry {
|
|
|
181
181
|
addViewProviders(providers: ViewProvider[]): void;
|
|
182
182
|
addViewTransformers(transformers: ViewTransformPlugin[]): void;
|
|
183
183
|
initializeViewProviders(): Promise<void[]>;
|
|
184
|
-
getView(viewId: ViewIdentity, skipCaching?: boolean): Promise<CompiledView>;
|
|
184
|
+
getView(viewId: ViewIdentity, runtimeParams: RuntimeParams, skipCaching?: boolean): Promise<CompiledView>;
|
|
185
185
|
getViewDefinition<R extends RuntimeEnvironment>(view: View, viewParams: ViewParams, runtimeEnvironment: R, runtimeParams?: RuntimeParams, renderOptions?: RenderOptions): Promise<LinkedViewDefinition>;
|
|
186
186
|
hasViewDefinition<R extends RuntimeEnvironment>(view: View, viewParams: ViewParams, runtimeEnvironment: R, runtimeParams?: RuntimeParams, renderOptions?: RenderOptions): boolean;
|
|
187
187
|
getPublicApi(): PublicViewRegistry;
|
|
@@ -202,7 +202,7 @@ export interface SsrRequestContext {
|
|
|
202
202
|
};
|
|
203
203
|
locale: string;
|
|
204
204
|
}
|
|
205
|
-
export interface
|
|
205
|
+
export interface SsrDataResponse {
|
|
206
206
|
props?: Json;
|
|
207
207
|
markup?: {
|
|
208
208
|
links?: {
|
package/package.json
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"build": "tsc -b"
|
|
9
9
|
},
|
|
10
10
|
"type": "module",
|
|
11
|
-
"version": "0.11.0-alpha.
|
|
11
|
+
"version": "0.11.0-alpha.5",
|
|
12
12
|
"homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
|
|
13
13
|
"repository": {
|
|
14
14
|
"type": "git",
|
|
@@ -29,5 +29,5 @@
|
|
|
29
29
|
"engines": {
|
|
30
30
|
"node": ">=16.0.0"
|
|
31
31
|
},
|
|
32
|
-
"gitHead": "
|
|
32
|
+
"gitHead": "207dae3cc23cef3e44b64099d7cf7fd07ab36080"
|
|
33
33
|
}
|