@lwrjs/types 0.15.0-alpha.16 → 0.15.0-alpha.18
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 +3 -1
- package/build/index.d.ts +3 -3
- package/build/server.d.ts +6 -1
- package/build/views.d.ts +10 -0
- package/package.json +2 -2
package/build/config.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
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';
|
|
1
|
+
import type { AssetProvider, AssetTransformPlugin, BundleProvider, CacheResponse, DirectToCoreProxy, LwrService, ModuleProvider, RenderOptions, ResourceProvider, RouteHandlerViewResponse, RuntimeEnvironment, ServerContext, ServerTypes, ServiceCtor, Specifier, UriTransformPlugin, ViewParams, ViewProvider, ViewRequest, ViewResponse, ViewTransformPlugin } from './index.js';
|
|
2
2
|
export interface View {
|
|
3
3
|
id: string;
|
|
4
4
|
rootComponent?: string;
|
|
@@ -114,6 +114,7 @@ export interface LwrGlobalConfig {
|
|
|
114
114
|
resourceProviders?: ServiceConfig[];
|
|
115
115
|
viewProviders?: ServiceConfig[];
|
|
116
116
|
viewTransformers?: ServiceConfig[];
|
|
117
|
+
caseSensitiveRoutes?: boolean;
|
|
117
118
|
routes?: LwrRoute[];
|
|
118
119
|
errorRoutes?: LwrErrorRoute[];
|
|
119
120
|
routeHandlers?: RouteHandlersConfig;
|
|
@@ -123,6 +124,7 @@ export interface LwrGlobalConfig {
|
|
|
123
124
|
locker?: LwrLockerConfig;
|
|
124
125
|
uriTransformers?: ServiceConfig[];
|
|
125
126
|
i18n?: I18NConfig;
|
|
127
|
+
coreProxy?: DirectToCoreProxy | null;
|
|
126
128
|
}
|
|
127
129
|
type RequiredPick<T, K extends keyof T> = {
|
|
128
130
|
[P in K]-?: T[P];
|
package/build/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@ import type { EventEmitter } from 'events';
|
|
|
7
7
|
import type fs from 'fs';
|
|
8
8
|
import type { Readable } from 'stream';
|
|
9
9
|
import type { BundleConfig, EnvironmentConfig, HooksPlugin, LwrLockerConfig, NormalizedLwrErrorRoute, NormalizedLwrGlobalConfig, NormalizedLwrRoute, ResolverModuleRecord, BundleConfigOverrides, RouteHandlers, AssetConfig, I18NConfig, ModuleRegistryConfig } from './config.js';
|
|
10
|
-
import type { AssetReference, CompiledView, PublicViewRegistry, ViewProvider, ViewRegistry, ViewTransformPlugin } from './views.js';
|
|
10
|
+
import type { AssetReference, CompiledView, DirectToCoreProxy, PublicViewRegistry, ViewProvider, ViewRegistry, ViewTransformPlugin } from './views.js';
|
|
11
11
|
export * from './lwr-shim.js';
|
|
12
12
|
export * from './config.js';
|
|
13
13
|
export * from './cli.js';
|
|
@@ -192,7 +192,7 @@ export interface RuntimeEnvironment extends ServerModeConfig {
|
|
|
192
192
|
export interface SourceMapRuntimeEnvironment extends RuntimeEnvironment {
|
|
193
193
|
sourceMapUrl?: string;
|
|
194
194
|
}
|
|
195
|
-
export type RuntimeParams = Record<string, string | number | boolean | null | undefined | Record<string, string
|
|
195
|
+
export type RuntimeParams = Record<string, string | number | boolean | null | undefined | Record<string, string> | DirectToCoreProxy> & {
|
|
196
196
|
requestCache?: Record<string, any>;
|
|
197
197
|
};
|
|
198
198
|
export interface EnvironmentContext {
|
|
@@ -320,7 +320,7 @@ export interface BundleRecord {
|
|
|
320
320
|
includedModules: string[];
|
|
321
321
|
}
|
|
322
322
|
export interface BundleDefinition extends ModuleId {
|
|
323
|
-
|
|
323
|
+
getCode: () => Promise<string>;
|
|
324
324
|
config: BundleConfig;
|
|
325
325
|
map?: any;
|
|
326
326
|
bundleRecord: BundleRecord;
|
package/build/server.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ import type { Application as ExpressApp } from 'express';
|
|
|
4
4
|
import type { default as Koa, Context } from 'koa';
|
|
5
5
|
import type http from 'http';
|
|
6
6
|
import type { Readable } from 'stream';
|
|
7
|
-
import type { NormalizedLwrGlobalConfig, RuntimeContext, RuntimeEnvironment } from './index.js';
|
|
7
|
+
import type { DirectToCoreProxy, NormalizedLwrGlobalConfig, RuntimeContext, RuntimeEnvironment } from './index.js';
|
|
8
8
|
export type ServerTypes = 'koa' | 'express' | 'fs';
|
|
9
9
|
export type ServerTypeImpl<T extends ServerTypes> = T extends 'koa' ? Koa : T extends 'express' ? ExpressApp : T extends 'fs' ? LwrDispatcher : never;
|
|
10
10
|
export interface FsContext extends Context {
|
|
@@ -37,6 +37,7 @@ export interface InternalAppServer<T extends ServerTypes> {
|
|
|
37
37
|
export type InternalAppServerOptions = {
|
|
38
38
|
app?: ServerTypeImpl<ServerTypes>;
|
|
39
39
|
basePath?: string;
|
|
40
|
+
caseSensitiveRoutes?: boolean;
|
|
40
41
|
};
|
|
41
42
|
export interface InternalAppServerConstructable {
|
|
42
43
|
new (options: InternalAppServerOptions): InternalAppServer<ServerTypes>;
|
|
@@ -89,6 +90,10 @@ export interface MiddlewareRequest {
|
|
|
89
90
|
* Use the request parameters to resolve the runtime context(ie. environment and parameters)
|
|
90
91
|
*/
|
|
91
92
|
getRuntimeContext(defaultRuntimeEnvironment: RuntimeEnvironment): RuntimeContext;
|
|
93
|
+
/**
|
|
94
|
+
* Resolve the Direct-to-Core proxy values for the SSR wrapped fetch endowment
|
|
95
|
+
*/
|
|
96
|
+
getCoreProxy(appCoreProxy?: DirectToCoreProxy, proxyForSSR?: boolean): DirectToCoreProxy | undefined;
|
|
92
97
|
}
|
|
93
98
|
export interface MiddlewareResponse {
|
|
94
99
|
hasHeader(name: string): boolean;
|
package/build/views.d.ts
CHANGED
|
@@ -127,6 +127,9 @@ export interface ViewDefinitionResponse {
|
|
|
127
127
|
headers?: Record<string, string>;
|
|
128
128
|
cookie?: 'wip';
|
|
129
129
|
locale?: string;
|
|
130
|
+
metadata?: {
|
|
131
|
+
viewDefinition?: LinkedViewDefinition;
|
|
132
|
+
};
|
|
130
133
|
}
|
|
131
134
|
export interface ViewProvider {
|
|
132
135
|
name: string;
|
|
@@ -171,6 +174,7 @@ export interface ViewInfo {
|
|
|
171
174
|
configAsSrc: boolean;
|
|
172
175
|
mixedMode: boolean;
|
|
173
176
|
nonce?: string;
|
|
177
|
+
ssr: boolean;
|
|
174
178
|
}
|
|
175
179
|
export interface RenderOptions {
|
|
176
180
|
skipMetadataCollection?: boolean;
|
|
@@ -258,5 +262,11 @@ export interface SsrRedirect {
|
|
|
258
262
|
status?: 301 | 302;
|
|
259
263
|
location: string;
|
|
260
264
|
}
|
|
265
|
+
export interface DirectToCoreProxy {
|
|
266
|
+
origin: string;
|
|
267
|
+
host: string;
|
|
268
|
+
servername?: string;
|
|
269
|
+
sitePath?: string;
|
|
270
|
+
}
|
|
261
271
|
export {};
|
|
262
272
|
//# sourceMappingURL=views.d.ts.map
|
package/package.json
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"build": "tsc -b"
|
|
9
9
|
},
|
|
10
10
|
"type": "module",
|
|
11
|
-
"version": "0.15.0-alpha.
|
|
11
|
+
"version": "0.15.0-alpha.18",
|
|
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": ">=18.0.0"
|
|
31
31
|
},
|
|
32
|
-
"gitHead": "
|
|
32
|
+
"gitHead": "fefc639770948be769b1ace03b7759e7b8906cae"
|
|
33
33
|
}
|