@lwrjs/core 0.9.0-alpha.2 → 0.9.0-alpha.21

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.
Files changed (77) hide show
  1. package/build/cjs/context/provider.cjs +84 -0
  2. package/build/cjs/context/server.cjs +75 -0
  3. package/build/cjs/index.cjs +69 -153
  4. package/build/cjs/middleware/asset-middleware.cjs +56 -0
  5. package/build/cjs/middleware/bundle-middleware.cjs +113 -0
  6. package/build/cjs/{middlewares → middleware}/hmr-middleware.cjs +4 -4
  7. package/build/cjs/{middlewares → middleware}/locale-middleware.cjs +2 -2
  8. package/build/cjs/middleware/mapping-middleware.cjs +61 -0
  9. package/build/cjs/middleware/module-middleware.cjs +88 -0
  10. package/build/cjs/middleware/redirects/unsigned-module-redirect.cjs +37 -0
  11. package/build/cjs/middleware/resource-middleware.cjs +64 -0
  12. package/build/cjs/{context/services.cjs → middleware/utils/error-handling.cjs} +28 -15
  13. package/build/cjs/middleware/utils/identity.cjs +93 -0
  14. package/build/cjs/{context/hooks.cjs → middleware/utils/metadata.cjs} +17 -26
  15. package/build/cjs/{middlewares/utils.cjs → middleware/utils/request.cjs} +17 -16
  16. package/build/cjs/middleware/view-middleware.cjs +151 -0
  17. package/build/cjs/middleware.cjs +43 -0
  18. package/build/cjs/tools/server-warmup.cjs +2 -9
  19. package/build/cjs/tools/static-generation.cjs +127 -49
  20. package/build/es/context/provider.d.ts +3 -0
  21. package/build/es/context/provider.js +39 -0
  22. package/build/es/context/server.d.ts +3 -0
  23. package/build/es/context/server.js +49 -0
  24. package/build/es/index.d.ts +4 -2
  25. package/build/es/index.js +89 -150
  26. package/build/es/middleware/asset-middleware.d.ts +3 -0
  27. package/build/es/middleware/asset-middleware.js +26 -0
  28. package/build/es/middleware/bundle-middleware.d.ts +3 -0
  29. package/build/es/middleware/bundle-middleware.js +88 -0
  30. package/build/es/middleware/hmr-middleware.d.ts +5 -0
  31. package/build/es/{middlewares → middleware}/hmr-middleware.js +2 -2
  32. package/build/es/middleware/locale-middleware.d.ts +3 -0
  33. package/build/es/{middlewares → middleware}/locale-middleware.js +2 -1
  34. package/build/es/middleware/mapping-middleware.d.ts +3 -0
  35. package/build/es/middleware/mapping-middleware.js +34 -0
  36. package/build/es/middleware/module-middleware.d.ts +3 -0
  37. package/build/es/middleware/module-middleware.js +64 -0
  38. package/build/es/middleware/redirects/unsigned-module-redirect.d.ts +6 -0
  39. package/build/es/middleware/redirects/unsigned-module-redirect.js +25 -0
  40. package/build/es/middleware/resource-middleware.d.ts +3 -0
  41. package/build/es/middleware/resource-middleware.js +37 -0
  42. package/build/es/middleware/utils/error-handling.d.ts +3 -0
  43. package/build/es/middleware/utils/error-handling.js +32 -0
  44. package/build/es/middleware/utils/identity.d.ts +6 -0
  45. package/build/es/middleware/utils/identity.js +64 -0
  46. package/build/es/middleware/utils/metadata.d.ts +3 -0
  47. package/build/es/middleware/utils/metadata.js +24 -0
  48. package/build/es/middleware/utils/request.d.ts +15 -0
  49. package/build/es/{middlewares/utils.js → middleware/utils/request.js} +15 -23
  50. package/build/es/middleware/view-middleware.d.ts +3 -0
  51. package/build/es/middleware/view-middleware.js +136 -0
  52. package/build/es/middleware.d.ts +9 -0
  53. package/build/es/middleware.js +13 -0
  54. package/build/es/tools/server-warmup.js +3 -10
  55. package/build/es/tools/static-generation.d.ts +8 -1
  56. package/build/es/tools/static-generation.js +155 -62
  57. package/build/es/tools/types.d.ts +3 -2
  58. package/package.json +36 -32
  59. package/build/cjs/context/global-data.cjs +0 -54
  60. package/build/cjs/middlewares/api-middleware.cjs +0 -359
  61. package/build/cjs/middlewares/base-middleware.cjs +0 -15
  62. package/build/cjs/middlewares/ui-middleware.cjs +0 -183
  63. package/build/es/context/global-data.d.ts +0 -3
  64. package/build/es/context/global-data.js +0 -29
  65. package/build/es/context/hooks.d.ts +0 -9
  66. package/build/es/context/hooks.js +0 -36
  67. package/build/es/context/services.d.ts +0 -8
  68. package/build/es/context/services.js +0 -17
  69. package/build/es/middlewares/api-middleware.d.ts +0 -3
  70. package/build/es/middlewares/api-middleware.js +0 -410
  71. package/build/es/middlewares/base-middleware.d.ts +0 -3
  72. package/build/es/middlewares/base-middleware.js +0 -4
  73. package/build/es/middlewares/hmr-middleware.d.ts +0 -5
  74. package/build/es/middlewares/locale-middleware.d.ts +0 -3
  75. package/build/es/middlewares/ui-middleware.d.ts +0 -3
  76. package/build/es/middlewares/ui-middleware.js +0 -186
  77. package/build/es/middlewares/utils.d.ts +0 -22
package/build/es/index.js CHANGED
@@ -1,178 +1,116 @@
1
- import { deepFreeze, getFeatureFlags, DEFAULT_LWR_BOOTSTRAP_CONFIG, logger } from '@lwrjs/shared-utils';
2
- import { LwrCompiler } from '@lwrjs/compiler';
3
- import { LwrModuleBundler } from '@lwrjs/module-bundler';
4
- import { LwrModuleRegistry } from '@lwrjs/module-registry';
5
- import { LwrResourceRegistry } from '@lwrjs/resource-registry';
6
- import { LwrAssetRegistry } from '@lwrjs/asset-registry';
7
- import { LwrViewRegistry } from '@lwrjs/view-registry';
8
- import { LwrServerError, createSingleDiagnosticError, descriptions } from '@lwrjs/diagnostics';
9
- import { normalizeConfig, explodeMode } from '@lwrjs/config';
10
- import { LwrApplicationObserver } from '@lwrjs/shared-utils';
11
- import localeMiddleware from './middlewares/locale-middleware.js';
12
- import apiMiddleware from './middlewares/api-middleware.js';
13
- import uiMiddleware from './middlewares/ui-middleware.js';
14
- import hmrMiddleware from './middlewares/hmr-middleware.js';
15
- import { getGlobalData } from './context/global-data.js';
16
- import { runConfigurationsHook } from './context/hooks.js';
17
- import baseMiddleware from './middlewares/base-middleware.js';
1
+ import { getFeatureFlags, DEFAULT_LWR_BOOTSTRAP_CONFIG, logger } from '@lwrjs/shared-utils';
18
2
  import { createInternalServer } from '@lwrjs/server';
19
- import { getServiceModule } from './context/services.js';
3
+ import { LwrServerError, createSingleDiagnosticError, descriptions } from '@lwrjs/diagnostics';
4
+ import { loadConfig, executeConfigHooks, executeStartHooks } from '@lwrjs/config';
5
+ import { loadHooks, loadServices, loadRouteHandlers } from '@lwrjs/config/modules';
20
6
  import SiteGenerator from './tools/static-generation.js';
21
7
  import { warmupServer } from './tools/server-warmup.js';
22
- // Parse the service constructors and instantiate them
23
- async function getServices(services, providerContext, lwrConfig) {
24
- return Promise.all(services.map(async (serviceEntry) => {
25
- const [serviceName, serviceConfig = {}] = Array.isArray(serviceEntry)
26
- ? serviceEntry
27
- : [serviceEntry];
28
- const ServiceCtor = await getServiceModule(serviceName, lwrConfig);
29
- return new ServiceCtor(serviceConfig, providerContext);
30
- }));
31
- }
32
- function initMiddlewares(app, server, serverContext) {
33
- // Base middlewares for cookies, session, admin authentication, gzip, ...
34
- baseMiddleware(app, serverContext);
8
+ import { createServerContext } from './context/server.js';
9
+ import { createProviderContext } from './context/provider.js';
10
+ import { localeMiddleware } from './middleware/locale-middleware.js';
11
+ import { moduleMiddleware } from './middleware/module-middleware.js';
12
+ import { bundleMiddleware } from './middleware/bundle-middleware.js';
13
+ import { mappingMiddleware } from './middleware/mapping-middleware.js';
14
+ import { assetMiddleware } from './middleware/asset-middleware.js';
15
+ import { viewMiddleware } from './middleware/view-middleware.js';
16
+ import { resourceMiddleware } from './middleware/resource-middleware.js';
17
+ import { hmrMiddleware } from './middleware/hmr-middleware.js';
18
+ function initMiddleware(app, server, serverContext) {
19
+ // all middleware attached AFTER compression will have compressed responses
20
+ app.useCompression();
35
21
  localeMiddleware(app, serverContext);
36
- apiMiddleware(app, serverContext);
37
- uiMiddleware(app, serverContext);
22
+ moduleMiddleware(app, serverContext);
23
+ bundleMiddleware(app, serverContext);
24
+ mappingMiddleware(app, serverContext);
25
+ assetMiddleware(app, serverContext);
26
+ resourceMiddleware(app, serverContext);
27
+ // view middleware MUST be attached last because it contains a greedy middleware
28
+ // to handle unsupported routes
29
+ viewMiddleware(app, serverContext);
30
+ // initialize routes MUST be called when using koa
31
+ app.initRoutes();
32
+ // hmr uses web sockets, so it doesn't matter when this is attached
38
33
  if (serverContext.runtimeEnvironment.hmrEnabled) {
39
- // setup hmr middleware
40
34
  hmrMiddleware(server, serverContext);
41
35
  }
42
36
  }
43
- async function initContext(app, server, rawLwrConfig) {
44
- const { apiVersion, basePath, lwrVersion, serverMode, globalDataDir, globalData } = rawLwrConfig;
45
- const rawDataConfig = getGlobalData(globalDataDir, globalData);
46
- const rawRuntimeEnvConfig = {
47
- ...explodeMode(serverMode),
48
- apiVersion,
49
- basePath,
50
- lwrVersion,
51
- debug: false,
52
- serverMode,
53
- featureFlags: getFeatureFlags(),
54
- };
55
- const hookProviders = await getServices(rawLwrConfig.hooks, undefined, rawLwrConfig);
56
- const { lwrConfig, dataConfig, runtimeConfig } = await runConfigurationsHook(hookProviders, rawLwrConfig, rawDataConfig, rawRuntimeEnvConfig);
57
- const assetTransformers = await getServices(rawLwrConfig.assetTransformers, undefined, rawLwrConfig);
58
- const appObserver = new LwrApplicationObserver();
59
- const appEmitter = appObserver.createLwrEmitter();
60
- const compiler = new LwrCompiler();
61
- const assetRegistry = new LwrAssetRegistry({
62
- assetTransformers,
63
- appObserver,
64
- appEmitter,
65
- runtimeEnvironment: runtimeConfig,
66
- }, lwrConfig);
67
- const moduleRegistry = new LwrModuleRegistry({
68
- compiler,
69
- appObserver,
70
- appEmitter,
71
- runtimeEnvironment: runtimeConfig,
72
- }, lwrConfig);
73
- const moduleBundler = new LwrModuleBundler({ compiler, moduleRegistry, appObserver }, lwrConfig);
74
- const resourceRegistry = new LwrResourceRegistry();
75
- const viewRegistry = new LwrViewRegistry({
76
- moduleRegistry,
77
- moduleBundler,
78
- resourceRegistry,
79
- assetRegistry,
80
- appObserver,
81
- appEmitter,
82
- globalData: dataConfig,
83
- runtimeEnvironment: runtimeConfig,
84
- }, lwrConfig);
85
- // Initialized PRIVATE server-side context, passed to middlewares
86
- const serverContext = {
87
- compiler,
88
- server,
89
- appObserver,
90
- appEmitter,
91
- moduleRegistry,
92
- moduleBundler,
93
- resourceRegistry,
94
- assetRegistry,
95
- viewRegistry,
96
- appConfig: lwrConfig,
97
- runtimeEnvironment: runtimeConfig,
98
- };
99
- // This is a subset of config to user-land code
100
- const { cacheDir, lwc: { modules = [] }, routes, errorRoutes, rootDir, contentDir, layoutsDir, locker, amdLoader, esmLoader, environment, } = lwrConfig;
101
- const { onModuleDefinitionChange, onModuleSourceChange } = appObserver;
102
- const { notifyModuleDefinitionChanged, notifyModuleSourceChanged, notifyViewSourceChanged, notifyAssetSourceChanged, } = appEmitter;
103
- const providerContext = {
104
- compiler,
105
- appObserver: deepFreeze({ onModuleDefinitionChange, onModuleSourceChange }),
106
- appEmitter: {
107
- notifyModuleDefinitionChanged: (payload) => notifyModuleDefinitionChanged.call(appEmitter, payload),
108
- notifyModuleSourceChanged: (payload) => notifyModuleSourceChanged.call(appEmitter, payload),
109
- notifyViewSourceChanged: (payload) => notifyViewSourceChanged.call(appEmitter, payload),
110
- notifyAssetSourceChanged: (payload) => notifyAssetSourceChanged.call(appEmitter, payload),
111
- },
112
- moduleRegistry: moduleRegistry.getPublicApi(),
113
- moduleBundler: moduleBundler,
114
- resourceRegistry: resourceRegistry.getPublicApi(),
115
- viewRegistry: viewRegistry.getPublicApi(),
116
- assetRegistry: assetRegistry.getPublicApi(),
117
- config: deepFreeze({
118
- cacheDir,
119
- modules,
120
- routes,
121
- errorRoutes,
122
- rootDir,
123
- basePath,
124
- contentDir,
125
- layoutsDir,
126
- locker,
127
- amdLoader,
128
- esmLoader,
129
- environment,
130
- }),
131
- runtimeEnvironment: deepFreeze(runtimeConfig),
132
- };
133
- // Module Providers
134
- const moduleProviders = await getServices(lwrConfig.moduleProviders, providerContext, lwrConfig);
37
+ function createServices(entries, providerContext) {
38
+ return entries.map(([ctor, providerConfig = {}]) => new ctor(providerConfig, providerContext));
39
+ }
40
+ async function initContext(appConfig, runtimeEnvironment, globalData) {
41
+ // load all hooks
42
+ const hooks = await loadHooks(appConfig);
43
+ // apply both config and on start hooks
44
+ if (hooks.length) {
45
+ await executeConfigHooks(hooks, appConfig, runtimeEnvironment, globalData);
46
+ executeStartHooks(hooks, appConfig);
47
+ }
48
+ // load all configurable modules
49
+ const services = await loadServices(appConfig);
50
+ // create all framework components(ie. registries)
51
+ const serverContext = createServerContext(appConfig, runtimeEnvironment, globalData);
52
+ // create public subset of configurations
53
+ const providerContext = createProviderContext(serverContext);
54
+ const { moduleRegistry, assetRegistry, resourceRegistry, viewRegistry, moduleBundler } = serverContext;
55
+ // instantiate each service
56
+ const moduleProviders = createServices(services.moduleProviders, providerContext);
57
+ const assetProviders = createServices(services.assetProviders, providerContext);
58
+ const assetTransformers = createServices(services.assetTransformers, providerContext);
59
+ const resourceProviders = createServices(services.resourceProviders, providerContext);
60
+ const viewProviders = createServices(services.viewProviders, providerContext);
61
+ const viewTransformers = createServices(services.viewTransformers, providerContext);
62
+ const bundleProviders = createServices(services.bundleProviders, providerContext);
63
+ // add services to their corresponding registry
135
64
  moduleRegistry.addModuleProviders(moduleProviders);
136
- // Resource Providers
137
- const resourceProviders = await getServices(lwrConfig.resourceProviders, providerContext, lwrConfig);
65
+ assetRegistry.addAssetProviders(assetProviders);
66
+ assetRegistry.addAssetTransformers(assetTransformers);
138
67
  resourceRegistry.addResourceProviders(resourceProviders);
139
- // View Providers
140
- const viewProviders = await getServices(lwrConfig.viewProviders, providerContext, lwrConfig);
141
- // View Transformers
142
- const viewTransformers = await getServices(rawLwrConfig.viewTransformers, providerContext, rawLwrConfig);
143
68
  viewRegistry.addViewProviders(viewProviders);
144
69
  viewRegistry.addViewTransformers(viewTransformers);
145
- await viewRegistry.initializeViewProviders();
146
- // Asset Providers
147
- const assetProviders = await getServices(lwrConfig.assetProviders, providerContext, lwrConfig);
148
- assetRegistry.addAssetProviders(assetProviders);
70
+ moduleBundler.addBundleProviders(bundleProviders);
71
+ // invoke async initialization
72
+ await serverContext.viewRegistry.initializeViewProviders();
73
+ // set routes on server context
74
+ const routeHandlers = await loadRouteHandlers(appConfig);
75
+ serverContext.routeHandlers = routeHandlers;
149
76
  return serverContext;
150
77
  }
151
78
  export class LwrApp {
152
- constructor(config) {
79
+ constructor(config = {}) {
153
80
  this.initialized = false;
154
- this.config = normalizeConfig(config);
81
+ const { appConfig, runtimeEnvironment, globalData } = loadConfig(config);
82
+ this.config = appConfig;
83
+ this.runtimeEnvironment = runtimeEnvironment;
84
+ this.globalData = globalData;
155
85
  const { basePath } = this.config;
156
86
  this.app = createInternalServer(this.config.serverType, { basePath });
157
87
  this.server = this.app.createHttpServer();
158
88
  }
159
89
  setConfig(config) {
160
- this.config = normalizeConfig(config);
90
+ const { appConfig, runtimeEnvironment, globalData } = loadConfig(config);
91
+ this.config = appConfig;
92
+ this.runtimeEnvironment = runtimeEnvironment;
93
+ this.globalData = globalData;
161
94
  }
162
95
  getConfig() {
163
96
  return this.config;
164
97
  }
165
98
  async init() {
166
- if (!this.initialized) {
167
- this.initialized = true;
168
- try {
169
- const context = await initContext(this.app, this.server, this.config);
170
- initMiddlewares(this.app, this.server, context);
171
- }
172
- catch (e) {
173
- this.initialized = false;
174
- throw e;
175
- }
99
+ if (this.initialized) {
100
+ return;
101
+ }
102
+ // preemptively mark the server as initialized
103
+ this.initialized = true;
104
+ try {
105
+ // create the application server context
106
+ const context = await initContext(this.config, this.runtimeEnvironment, this.globalData);
107
+ // attach framework middleware to the server
108
+ initMiddleware(this.app, this.server, context);
109
+ }
110
+ catch (e) {
111
+ // reset the initialized property if the server fails to initialize
112
+ this.initialized = false;
113
+ throw e;
176
114
  }
177
115
  }
178
116
  async listen(callback) {
@@ -234,7 +172,7 @@ export async function generateStaticSite(config) {
234
172
  const { serverMode } = config;
235
173
  if (serverMode === 'dev' || serverMode === 'compat') {
236
174
  // TODO: dynamic imports are not generated in dev mode
237
- // https://github.com/salesforce/lwr/issues/1111
175
+ // https://github.com/salesforce-experience-platform-emu/lwr/issues/1111
238
176
  logger.warn('static generation in `dev` or `compat` mode is currently not fully supported');
239
177
  }
240
178
  const lwrApp = createServer(config);
@@ -242,6 +180,7 @@ export async function generateStaticSite(config) {
242
180
  await lwrApp.init();
243
181
  const dispatcher = lwrApp.getInternalServer();
244
182
  await new SiteGenerator().buildStaticApplication(lwrApp.getConfig(), dispatcher);
183
+ return lwrApp.getConfig();
245
184
  }
246
185
  /**
247
186
  * Create normalized config for static generation forcing the app config to come as src
@@ -0,0 +1,3 @@
1
+ import type { InternalAppServer, ServerContext, ServerTypes } from '@lwrjs/types';
2
+ export declare function assetMiddleware<T extends ServerTypes>(app: InternalAppServer<T>, context: ServerContext): void;
3
+ //# sourceMappingURL=asset-middleware.d.ts.map
@@ -0,0 +1,26 @@
1
+ import path from 'path';
2
+ import { getAssetIdentity } from './utils/identity.js';
3
+ import { handleErrors } from './utils/error-handling.js';
4
+ function createAssetMiddleware(context) {
5
+ const { assetRegistry, runtimeEnvironment: { basePath }, } = context;
6
+ return async (req, res) => {
7
+ const { runtimeEnvironment } = req.getRuntimeContext(context.runtimeEnvironment);
8
+ const { assetId, signature } = getAssetIdentity(req);
9
+ if (basePath && !assetId.specifier.startsWith(basePath)) {
10
+ assetId.specifier = path.join(basePath, assetId.specifier);
11
+ }
12
+ const asset = await assetRegistry.getAsset({ ...assetId, signature }, runtimeEnvironment, req.isSiteGeneration());
13
+ if (req.isSiteGeneration()) {
14
+ res.setSiteGenerationMetadata({ asset });
15
+ }
16
+ if (asset.mime) {
17
+ res.type(asset.mime);
18
+ }
19
+ res.status(200).stream(asset.stream());
20
+ };
21
+ }
22
+ export function assetMiddleware(app, context) {
23
+ const paths = context.appConfig.assets.map((a) => a.urlPath + app.getRegexWildcard());
24
+ app.get([...paths, '/:apiVersion/:assetType/:immutable?/s/:signature/' + app.getRegexWildcard()], handleErrors(createAssetMiddleware(context)));
25
+ }
26
+ //# sourceMappingURL=asset-middleware.js.map
@@ -0,0 +1,3 @@
1
+ import type { InternalAppServer, ServerContext, ServerTypes } from '@lwrjs/types';
2
+ export declare function bundleMiddleware<T extends ServerTypes>(app: InternalAppServer<T>, context: ServerContext): void;
3
+ //# sourceMappingURL=bundle-middleware.d.ts.map
@@ -0,0 +1,88 @@
1
+ import { LATEST_SIGNATURE } from '@lwrjs/shared-utils';
2
+ import { descriptions } from '@lwrjs/diagnostics';
3
+ import { getRequestImporter } from './utils/request.js';
4
+ import { getModuleIdentity } from './utils/identity.js';
5
+ import { normalizeResolvedUris } from './utils/metadata.js';
6
+ import { createUnsignedBundleRedirect } from './redirects/unsigned-module-redirect.js';
7
+ import { handleErrors } from './utils/error-handling.js';
8
+ function createBundleMiddleware(context) {
9
+ const { moduleRegistry, moduleBundler } = context;
10
+ const unsignedBundleRedirect = createUnsignedBundleRedirect(moduleBundler);
11
+ return async (req, res) => {
12
+ if (!req.validateEnvironmentRequest(context.appConfig)) {
13
+ res.status(400);
14
+ res.send(descriptions.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
15
+ return;
16
+ }
17
+ if (!req.validateJsonRequest()) {
18
+ res.status(400);
19
+ res.send(descriptions.UNRESOLVABLE.INVALID_JSON().message);
20
+ return;
21
+ }
22
+ const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(context.runtimeEnvironment);
23
+ const importer = req.query.importer ? await getRequestImporter(req, moduleRegistry) : undefined;
24
+ const { moduleId, signature } = getModuleIdentity(req, importer);
25
+ if (moduleId.importer || !signature) {
26
+ await unsignedBundleRedirect(req, res, moduleId, runtimeEnvironment, runtimeParams);
27
+ return;
28
+ }
29
+ const sourceMapUrl = req.path.replace('/bundle/', '/sourcemaps/bundle/');
30
+ const bundleDefinition = await moduleBundler.getModuleBundle(moduleId,
31
+ // bundle must be `true` to properly resolve bundles in amd
32
+ { ...runtimeEnvironment, bundle: true, sourceMapUrl }, runtimeParams);
33
+ if (req.isSiteGeneration()) {
34
+ res.setSiteGenerationMetadata({
35
+ moduleDefinition: bundleDefinition,
36
+ resolvedUris: await normalizeResolvedUris(bundleDefinition, runtimeEnvironment, runtimeParams, moduleBundler, moduleRegistry),
37
+ });
38
+ }
39
+ if (signature !== LATEST_SIGNATURE) {
40
+ res.setHeader('Cache-control', 'public, max-age=31536000, immutable');
41
+ }
42
+ res.status(200).type('application/javascript').send(bundleDefinition.code);
43
+ };
44
+ }
45
+ function createSourceMapMiddleware(context) {
46
+ const { moduleBundler } = context;
47
+ return async (req, res) => {
48
+ if (!req.validateEnvironmentRequest(context.appConfig)) {
49
+ res.status(400);
50
+ res.send(descriptions.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
51
+ return;
52
+ }
53
+ const { runtimeEnvironment } = req.getRuntimeContext(context.runtimeEnvironment);
54
+ const { moduleId, signature } = getModuleIdentity(req);
55
+ const bundleDef = await moduleBundler.getModuleBundle(moduleId, runtimeEnvironment);
56
+ if (signature !== LATEST_SIGNATURE) {
57
+ res.setHeader('Cache-control', 'public, max-age=31536000, immutable');
58
+ }
59
+ res.status(200).type('application/json').send(bundleDef.map);
60
+ };
61
+ }
62
+ export function bundleMiddleware(app, context) {
63
+ app.get([
64
+ `/:apiVersion/bundle/:format/:compat?/l/:locale/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
65
+ `/:apiVersion/bundle/:format/:compat?/l/:locale/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
66
+ `/:apiVersion/bundle/:format/:compat?/l/:locale/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
67
+ `/:apiVersion/bundle/:format/:compat?/l/:locale/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
68
+ `/:apiVersion/bundle/:format/:compat?/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
69
+ `/:apiVersion/bundle/:format/:compat?/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
70
+ `/:apiVersion/bundle/:format/:compat?/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
71
+ `/:apiVersion/bundle/:format/:compat?/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
72
+ `/:apiVersion/bundle/:format/:compat?/l/:locale/e/:environment/bi/:bundleSpecifier/module/mi/:specifier`,
73
+ `/:apiVersion/bundle/:format/:compat?/l/:locale/bi/:bundleSpecifier/module/mi/:specifier`,
74
+ `/:apiVersion/bundle/:format/:compat?/e/:environment/bi/:bundleSpecifier/module/mi/:specifier`,
75
+ `/:apiVersion/bundle/:format/:compat?/bi/:bundleSpecifier/module/mi/:specifier`,
76
+ ], handleErrors(createBundleMiddleware(context)));
77
+ app.get([
78
+ `/:apiVersion/sourcemaps/bundle/:format/:compat?/l/:locale/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
79
+ `/:apiVersion/sourcemaps/bundle/:format/:compat?/l/:locale/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
80
+ `/:apiVersion/sourcemaps/bundle/:format/:compat?/l/:locale/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
81
+ `/:apiVersion/sourcemaps/bundle/:format/:compat?/l/:locale/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
82
+ `/:apiVersion/sourcemaps/bundle/:format/:compat?/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
83
+ `/:apiVersion/sourcemaps/bundle/:format/:compat?/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
84
+ `/:apiVersion/sourcemaps/bundle/:format/:compat?/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
85
+ `/:apiVersion/sourcemaps/bundle/:format/:compat?/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
86
+ ], handleErrors(createSourceMapMiddleware(context)));
87
+ }
88
+ //# sourceMappingURL=bundle-middleware.js.map
@@ -0,0 +1,5 @@
1
+ /// <reference types="node" />
2
+ import type { ServerContext } from '@lwrjs/types';
3
+ import http from 'http';
4
+ export declare function hmrMiddleware(server: http.Server, context: ServerContext): void;
5
+ //# sourceMappingURL=hmr-middleware.d.ts.map
@@ -1,6 +1,6 @@
1
1
  import { WebSocketServer } from 'ws';
2
2
  import { getCacheKeyFromJson } from '@lwrjs/shared-utils';
3
- import { getRequestProperties } from './utils.js';
3
+ import { getRequestProperties } from './utils/request.js';
4
4
  let hmr;
5
5
  class Hmr {
6
6
  constructor(server, context) {
@@ -100,7 +100,7 @@ class Hmr {
100
100
  }
101
101
  }
102
102
  }
103
- export default function hmrMiddleware(server, context) {
103
+ export function hmrMiddleware(server, context) {
104
104
  hmr = new Hmr(server, context);
105
105
  hmr.setupHotModuleReload();
106
106
  }
@@ -0,0 +1,3 @@
1
+ import type { ServerContext, InternalAppServer, ServerTypes } from '@lwrjs/types';
2
+ export declare function localeMiddleware<T extends ServerTypes>(app: InternalAppServer<T>, context: ServerContext): void;
3
+ //# sourceMappingURL=locale-middleware.d.ts.map
@@ -1,8 +1,9 @@
1
- export default function localeMiddleware(app, context) {
1
+ export function localeMiddleware(app, context) {
2
2
  const { defaultLocale } = context.runtimeEnvironment;
3
3
  app.use(async (req, res, next) => {
4
4
  const langs = req.acceptsLanguages();
5
5
  req.locale = langs?.length > 0 ? langs[0] : defaultLocale;
6
+ // await is required when calling next to support koa
6
7
  await next();
7
8
  });
8
9
  }
@@ -0,0 +1,3 @@
1
+ import type { InternalAppServer, ServerContext, ServerTypes } from '@lwrjs/types';
2
+ export declare function mappingMiddleware<T extends ServerTypes>(app: InternalAppServer<T>, context: ServerContext): void;
3
+ //# sourceMappingURL=mapping-middleware.d.ts.map
@@ -0,0 +1,34 @@
1
+ import { getImportMetadataMappings } from '@lwrjs/shared-utils';
2
+ import { descriptions } from '@lwrjs/diagnostics';
3
+ import { getMappingIdentity } from './utils/identity.js';
4
+ import { handleErrors } from './utils/error-handling.js';
5
+ function createMappingMiddleware(context) {
6
+ const { moduleBundler, moduleRegistry } = context;
7
+ return async (req, res) => {
8
+ if (!req.validateEnvironmentRequest(context.appConfig)) {
9
+ res.status(400);
10
+ res.send(descriptions.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
11
+ return;
12
+ }
13
+ const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(context.runtimeEnvironment);
14
+ const { moduleIds } = getMappingIdentity(req);
15
+ const importMetadata = await getImportMetadataMappings(moduleIds, runtimeEnvironment, runtimeParams, moduleRegistry, moduleBundler);
16
+ if (req.isSiteGeneration()) {
17
+ res.setSiteGenerationMetadata({ importMetadata });
18
+ }
19
+ res.status(200).type('application/json').send(importMetadata);
20
+ };
21
+ }
22
+ export function mappingMiddleware(app, context) {
23
+ app.get([
24
+ `/:apiVersion/mapping/:format/:compat/l/:locale/e/:environment/bi/:bundleSpecifier/mp/:specifiers`,
25
+ `/:apiVersion/mapping/:format/:compat/l/:locale/e/:environment/mp/:specifiers`,
26
+ `/:apiVersion/mapping/:format/:compat/l/:locale/bi/:bundleSpecifier/mp/:specifiers`,
27
+ `/:apiVersion/mapping/:format/:compat/e/:environment/bi/:bundleSpecifier/mp/:specifiers`,
28
+ `/:apiVersion/mapping/:format/:compat/l/:locale/mp/:specifiers`,
29
+ `/:apiVersion/mapping/:format/:compat/e/:environment/mp/:specifiers`,
30
+ `/:apiVersion/mapping/:format/:compat/bi/:bundleSpecifier/mp/:specifiers`,
31
+ `/:apiVersion/mapping/:format/:compat/mp/:specifiers`,
32
+ ], handleErrors(createMappingMiddleware(context)));
33
+ }
34
+ //# sourceMappingURL=mapping-middleware.js.map
@@ -0,0 +1,3 @@
1
+ import type { InternalAppServer, ServerContext, ServerTypes } from '@lwrjs/types';
2
+ export declare function moduleMiddleware<T extends ServerTypes>(app: InternalAppServer<T>, context: ServerContext): void;
3
+ //# sourceMappingURL=module-middleware.d.ts.map
@@ -0,0 +1,64 @@
1
+ import { descriptions } from '@lwrjs/diagnostics';
2
+ import { LATEST_SIGNATURE, serializeModuleToJson } from '@lwrjs/shared-utils';
3
+ import { getRequestImporter } from './utils/request.js';
4
+ import { getModuleIdentity } from './utils/identity.js';
5
+ import { createUnsignedModuleRedirect } from './redirects/unsigned-module-redirect.js';
6
+ import { handleErrors } from './utils/error-handling.js';
7
+ function createModuleMiddleware(context) {
8
+ const { moduleRegistry } = context;
9
+ const unsignedRedirect = createUnsignedModuleRedirect(moduleRegistry);
10
+ return async (req, res) => {
11
+ if (!req.validateEnvironmentRequest(context.appConfig)) {
12
+ res.status(400);
13
+ res.send(descriptions.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
14
+ return;
15
+ }
16
+ if (!req.validateJsonRequest()) {
17
+ res.status(400);
18
+ res.send(descriptions.UNRESOLVABLE.INVALID_JSON().message);
19
+ return;
20
+ }
21
+ const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(context.runtimeEnvironment);
22
+ const importer = req.query.importer ? await getRequestImporter(req, moduleRegistry) : undefined;
23
+ const { moduleId, signature } = getModuleIdentity(req, importer);
24
+ if (moduleId.importer || !signature) {
25
+ await unsignedRedirect(req, res, moduleId, runtimeEnvironment, runtimeParams);
26
+ return;
27
+ }
28
+ const moduleDefinition = await moduleRegistry.getLinkedModule(moduleId,
29
+ // bundle must be `false` to resolve amd modules in `prod-compat` mode
30
+ { ...runtimeEnvironment, bundle: false }, runtimeParams);
31
+ const { ownHash, linkedSource } = moduleDefinition;
32
+ // validate the requested instances exists
33
+ if (signature !== LATEST_SIGNATURE && ownHash !== signature) {
34
+ res.status(404).send(descriptions.UNRESOLVABLE.SIGNED_MODULE(moduleId.specifier, signature).message);
35
+ return;
36
+ }
37
+ if (req.isSiteGeneration()) {
38
+ res.setSiteGenerationMetadata({ moduleDefinition });
39
+ }
40
+ if (req.isJsonRequest()) {
41
+ const json = await serializeModuleToJson(linkedSource, moduleDefinition, moduleRegistry, runtimeParams);
42
+ res.status(200).type('application/json').send(json);
43
+ return;
44
+ }
45
+ res.status(200).type('application/javascript').send(linkedSource);
46
+ };
47
+ }
48
+ export function moduleMiddleware(app, context) {
49
+ app.get([
50
+ `/:apiVersion/module/:format/:compat/l/:locale/e/:environment/mi/:specifier/latest/:prettyUrl?`,
51
+ `/:apiVersion/module/:format/:compat/l/:locale/e/:environment/mi/:specifier/s/:signature/:prettyUrl?`,
52
+ `/:apiVersion/module/:format/:compat/l/:locale/mi/:specifier/latest/:prettyUrl?`,
53
+ `/:apiVersion/module/:format/:compat/l/:locale/mi/:specifier/s/:signature/:prettyUrl?`,
54
+ `/:apiVersion/module/:format/:compat/e/:environment/mi/:specifier/latest/:prettyUrl?`,
55
+ `/:apiVersion/module/:format/:compat/e/:environment/mi/:specifier/s/:signature/:prettyUrl?`,
56
+ `/:apiVersion/module/:format/:compat/mi/:specifier/latest/:prettyUrl?`,
57
+ `/:apiVersion/module/:format/:compat/mi/:specifier/s/:signature/:prettyUrl?`,
58
+ `/:apiVersion/module/:format/:compat/l/:locale/e/:environment/mi/:specifier`,
59
+ `/:apiVersion/module/:format/:compat/l/:locale/mi/:specifier`,
60
+ `/:apiVersion/module/:format/:compat/e/:environment/mi/:specifier`,
61
+ `/:apiVersion/module/:format/:compat/mi/:specifier`,
62
+ ], handleErrors(createModuleMiddleware(context)));
63
+ }
64
+ //# sourceMappingURL=module-middleware.js.map
@@ -0,0 +1,6 @@
1
+ import type { AbstractModuleId, MiddlewareRequest, MiddlewareResponse, ModuleBundler, ModuleRegistry, RuntimeEnvironment, RuntimeParams } from '@lwrjs/types';
2
+ declare type UnsignedRedirect = (req: MiddlewareRequest, res: MiddlewareResponse, moduleId: AbstractModuleId, runtimeEnvironment: RuntimeEnvironment, runtimeParams: RuntimeParams) => Promise<void>;
3
+ export declare function createUnsignedModuleRedirect(moduleRegistry: ModuleRegistry): UnsignedRedirect;
4
+ export declare function createUnsignedBundleRedirect(moduleBundler: ModuleBundler): UnsignedRedirect;
5
+ export {};
6
+ //# sourceMappingURL=unsigned-module-redirect.d.ts.map
@@ -0,0 +1,25 @@
1
+ const HEADER_LOCATION = 'Location';
2
+ const STATUS_FOUND = 302;
3
+ export function createUnsignedModuleRedirect(moduleRegistry) {
4
+ return async (req, res, moduleId, runtimeEnvironment, runtimeParams) => {
5
+ const jsonQuery = getJsonQualifier(req, runtimeEnvironment);
6
+ const { moduleEntry, ownHash } = await moduleRegistry.getModule(moduleId);
7
+ const uri = await moduleRegistry.resolveModuleUri({ ...moduleId, version: moduleEntry.version }, runtimeEnvironment, runtimeParams, ownHash);
8
+ sendRedirect(res, `${uri}${jsonQuery}`);
9
+ };
10
+ }
11
+ export function createUnsignedBundleRedirect(moduleBundler) {
12
+ return async (req, res, moduleId, runtimeEnvironment, runtimeParams) => {
13
+ const jsonQuery = getJsonQualifier(req, runtimeEnvironment);
14
+ const uri = await moduleBundler.resolveModuleUri(moduleId, runtimeEnvironment, runtimeParams);
15
+ sendRedirect(res, `${uri}${jsonQuery}`);
16
+ };
17
+ }
18
+ function getJsonQualifier(req, runtimeEnvironment) {
19
+ return req.isJsonRequest() ? `${runtimeEnvironment.debug ? '&' : '?'}json` : '';
20
+ }
21
+ function sendRedirect(res, url) {
22
+ res.setHeader(HEADER_LOCATION, url);
23
+ res.sendStatus(STATUS_FOUND);
24
+ }
25
+ //# sourceMappingURL=unsigned-module-redirect.js.map
@@ -0,0 +1,3 @@
1
+ import type { InternalAppServer, ServerContext, ServerTypes } from '@lwrjs/types';
2
+ export declare function resourceMiddleware<T extends ServerTypes>(app: InternalAppServer<T>, context: ServerContext): void;
3
+ //# sourceMappingURL=resource-middleware.d.ts.map