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

package/build/es/middlewares/api-middleware.d.ts

@@ -1,3 +0,0 @@
-import { ServerContext, InternalAppServer, ServerTypes } from '@lwrjs/types';
-export default function apiMiddleware<T extends ServerTypes>(app: InternalAppServer<T>, context: ServerContext): void;
-//# sourceMappingURL=api-middleware.d.ts.map

package/build/es/middlewares/api-middleware.js

@@ -1,410 +0,0 @@
-import { createReturnStatus, LwrUnresolvableError, createSingleDiagnosticError as createDiagnostic, descriptions, } from '@lwrjs/diagnostics';
-import { LATEST_SIGNATURE, explodeSpecifier, getImportMetadataMappings, serializeModuleToJson, getModuleIdentity, getResourceIdentity, getAssetIdentity, getMappingIdentity, getVersionedModuleId, } from '@lwrjs/shared-utils';
-import { isSupportedEnvironment } from './utils.js';
-export default function apiMiddleware(app, context) {
-    const { appConfig: { environment: environmentConfig }, moduleRegistry, moduleBundler, resourceRegistry, runtimeEnvironment: defaultRuntimeEnvironment, } = context;
-    const errors = descriptions.UNRESOLVABLE;
-    // Bundle APIs
-    // {apiversion}/bundle/{format}/{compat}/bi/{bundlingId}-{bundlingSet}/module/mi/{specifier}/s/{signature}?{modifiers}
-    app.get([
-        // Full URL
-        `/:apiVersion/bundle/:format/:compat?/l/:locale/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/bundle/:format/:compat?/l/:locale/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
-        // Without Environment
-        `/:apiVersion/bundle/:format/:compat?/l/:locale/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/bundle/:format/:compat?/l/:locale/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
-        // Without Locale
-        `/:apiVersion/bundle/:format/:compat?/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/bundle/:format/:compat?/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
-        // Without Optional Segments
-        `/:apiVersion/bundle/:format/:compat?/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/bundle/:format/:compat?/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
-    ], async (req, res) => {
-        const runtimeContext = req.getRuntimeContext(defaultRuntimeEnvironment);
-        const { runtimeEnvironment, runtimeParams } = runtimeContext;
-        const targetEnvironment = runtimeParams.environment;
-        if (!isSupportedEnvironment(environmentConfig, targetEnvironment)) {
-            res.status(400).send({ error: `Environment "${targetEnvironment}" is not supported` });
-            return;
-        }
-        let moduleId, signature;
-        try {
-            ({ moduleId, signature } = getModuleIdentity(req));
-            const sourceMapUrl = req.path.replace('/bundle/', '/sourcemaps/bundle/');
-            const sourceMapRuntimeContext = { ...runtimeEnvironment, sourceMapUrl };
-            // Redirect module requests to the concrete URL when requested with an importer
-            const importerSpecifier = req.query.importer;
-            if (importerSpecifier) {
-                // Get the importer's file path entry
-                const importerModuleId = explodeSpecifier(importerSpecifier);
-                const { entry } = await moduleRegistry.getModuleEntry(importerModuleId);
-                const versionedModuleEntry = await moduleRegistry.getModuleEntry({
-                    ...moduleId,
-                    importer: entry,
-                });
-                const uri = await moduleRegistry.resolveModuleUri({ ...moduleId, version: versionedModuleEntry.version }, runtimeEnvironment, runtimeParams);
-                res.set({
-                    // This redirects to a signed URI
-                    // A prettifier is added to the end so resources have a meaningful name in browser devtools
-                    Location: uri,
-                });
-                res.sendStatus(302);
-                return;
-            }
-            const bundleDef = await moduleBundler.getModuleBundle(moduleId, sourceMapRuntimeContext, runtimeParams);
-            if (signature !== LATEST_SIGNATURE) {
-                res.setHeader('Cache-control', 'public, max-age=31536000, immutable');
-            }
-            // URIs for generate site
-            const resolvedUris = [];
-            if (req.isSiteGeneration()) {
-                // TODO might be able to remove this in the future but not sure how to properly send
-                // back bundleRecord imports with absolute uris (lwc is the main one)
-                if (bundleDef.bundleRecord.imports) {
-                    for (const theImport of bundleDef.bundleRecord.imports) {
-                        const childSpecifier = theImport.specifier;
-                        // eslint-disable-next-line no-await-in-loop
-                        const id = await getVersionedModuleId(childSpecifier, moduleRegistry);
-                        // eslint-disable-next-line no-await-in-loop
-                        const uri = await moduleRegistry.resolveModuleUri(id, runtimeEnvironment, runtimeParams);
-                        resolvedUris.push(uri);
-                    }
-                }
-                if (bundleDef.bundleRecord.dynamicImports) {
-                    for (const theImport of bundleDef.bundleRecord.dynamicImports) {
-                        const childSpecifier = theImport.specifier;
-                        // eslint-disable-next-line no-await-in-loop
-                        const id = await getVersionedModuleId(childSpecifier, moduleRegistry);
-                        // eslint-disable-next-line no-await-in-loop
-                        const uri = await moduleRegistry.resolveModuleUri(id, runtimeEnvironment, runtimeParams);
-                        resolvedUris.push(uri);
-                    }
-                }
-            }
-            res.setMetadata({ moduleDefinition: bundleDef, resolvedUris });
-            res.type('application/javascript').send(bundleDef.code);
-        }
-        catch (e) {
-            console.log(e);
-            const error = createReturnStatus(`bundle for "${moduleId?.specifier || req.params?.specifier}"`, e);
-            res.status(error.status).type('text/plain').send(error.message);
-        }
-    });
-    // Unsigned Bundles => 302
-    app.get([
-        // Full URL
-        `/:apiVersion/bundle/:format/:compat?/l/:locale/e/:environment/bi/:bundleSpecifier/module/mi/:specifier`,
-        // Without Environment
-        `/:apiVersion/bundle/:format/:compat?/l/:locale/bi/:bundleSpecifier/module/mi/:specifier`,
-        // Without Locale
-        `/:apiVersion/bundle/:format/:compat?/e/:environment/bi/:bundleSpecifier/module/mi/:specifier`,
-        // Without Optional Segments
-        `/:apiVersion/bundle/:format/:compat?/bi/:bundleSpecifier/module/mi/:specifier`,
-    ], async (req, res) => {
-        const ctx = req.getRuntimeContext(defaultRuntimeEnvironment);
-        const targetEnvironment = ctx.runtimeParams.environment;
-        if (!isSupportedEnvironment(environmentConfig, targetEnvironment)) {
-            res.status(400).send({ error: `Environment "${targetEnvironment}" is not supported` });
-            return;
-        }
-        let moduleId;
-        try {
-            ({ moduleId } = getModuleIdentity(req));
-            // Get the importer's specifier via the "importer" query param
-            const importerSpecifier = req.query.importer;
-            if (importerSpecifier) {
-                // Get the importer's file path entry
-                const importerModuleId = explodeSpecifier(importerSpecifier);
-                const { entry } = await moduleRegistry.getModuleEntry(importerModuleId);
-                moduleId = { ...moduleId, importer: entry };
-            }
-            const { ownHash, moduleEntry } = await moduleRegistry.getModule(moduleId, ctx.runtimeParams);
-            if (ownHash) {
-                const jsonQuery = req.isJsonRequest()
-                    ? `${ctx.runtimeEnvironment.debug ? '&' : '?'}json`
-                    : '';
-                const uri = await moduleRegistry.resolveModuleUri({ ...moduleId, version: moduleEntry.version }, ctx.runtimeEnvironment, ctx.runtimeParams, ownHash);
-                res.set({
-                    // This redirects to a signed URI
-                    Location: `${uri}${jsonQuery}`,
-                });
-                res.sendStatus(302);
-            }
-        }
-        catch (e) {
-            console.log(e);
-            const error = createReturnStatus(`bundle for "${moduleId?.specifier || req.params?.specifier}"`, e);
-            res.status(error.status).type('text/plain').send(error.message);
-        }
-    });
-    // Bundle sourcemaps
-    app.get([
-        // Full URL
-        `/:apiVersion/sourcemaps/bundle/:format/:compat?/l/:locale/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/sourcemaps/bundle/:format/:compat?/l/:locale/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
-        // Without Environment
-        `/:apiVersion/sourcemaps/bundle/:format/:compat?/l/:locale/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/sourcemaps/bundle/:format/:compat?/l/:locale/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
-        // Without Locale
-        `/:apiVersion/sourcemaps/bundle/:format/:compat?/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/sourcemaps/bundle/:format/:compat?/e/:environment/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
-        // Without Optional Segments
-        `/:apiVersion/sourcemaps/bundle/:format/:compat?/bi/:bundleSpecifier/module/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/sourcemaps/bundle/:format/:compat?/bi/:bundleSpecifier/module/mi/:specifier/s/:signature/:prettyUrl?`,
-    ], async (req, res) => {
-        const runtimeContext = req.getRuntimeContext(defaultRuntimeEnvironment);
-        const { runtimeParams, runtimeEnvironment } = runtimeContext;
-        const targetEnvironment = runtimeParams.environment;
-        if (!isSupportedEnvironment(environmentConfig, targetEnvironment)) {
-            res.status(400).send({ error: `Environment "${targetEnvironment}" is not supported` });
-            return;
-        }
-        let moduleId, signature;
-        try {
-            ({ moduleId, signature } = getModuleIdentity(req));
-            const bundleDef = await moduleBundler.getModuleBundle(moduleId, runtimeEnvironment);
-            if (signature !== LATEST_SIGNATURE) {
-                res.setHeader('Cache-control', 'public, max-age=31536000, immutable');
-            }
-            res.type('application/json').send(bundleDef.map);
-        }
-        catch (e) {
-            console.log(e);
-            const error = createReturnStatus(`bundle sourcemap for "${moduleId?.specifier || req.params?.specifier}"`, e);
-            res.status(error.status).type('text/plain').send(error.message);
-        }
-    });
-    // Signed Modules
-    // /{apiversion}/module/{format}/{compat}/l/{language}/mi/{specifier}/s/{signature}
-    app.get([
-        // Full URL
-        `/:apiVersion/module/:format/:compat/l/:locale/e/:environment/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/module/:format/:compat/l/:locale/e/:environment/mi/:specifier/s/:signature/:prettyUrl?`,
-        // Without Environment
-        `/:apiVersion/module/:format/:compat/l/:locale/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/module/:format/:compat/l/:locale/mi/:specifier/s/:signature/:prettyUrl?`,
-        // Without Locale
-        `/:apiVersion/module/:format/:compat/e/:environment/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/module/:format/:compat/e/:environment/mi/:specifier/s/:signature/:prettyUrl?`,
-        // Without Optional Segments
-        `/:apiVersion/module/:format/:compat/mi/:specifier/latest/:prettyUrl?`,
-        `/:apiVersion/module/:format/:compat/mi/:specifier/s/:signature/:prettyUrl?`,
-    ], async (req, res) => {
-        const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(defaultRuntimeEnvironment);
-        const targetEnvironment = runtimeParams.environment;
-        if (!isSupportedEnvironment(environmentConfig, targetEnvironment)) {
-            res.status(400).send({ error: `Environment "${targetEnvironment}" is not supported` });
-            return;
-        }
-        let moduleId, signature;
-        try {
-            ({ moduleId, signature } = getModuleIdentity(req));
-            if (!req.validateJsonRequest()) {
-                throw createDiagnostic({ description: errors.INVALID_JSON() }, LwrUnresolvableError);
-            }
-            // retrieve the latest module
-            const theModule = await moduleRegistry.getLinkedModule(moduleId, runtimeEnvironment, runtimeParams);
-            const { ownHash, linkedSource } = theModule;
-            // validate the requested instances exists
-            if (signature === LATEST_SIGNATURE || ownHash === signature) {
-                const code = linkedSource;
-                res.setMetadata({ moduleDefinition: theModule });
-                if (req.isJsonRequest()) {
-                    const json = await serializeModuleToJson(code, theModule, moduleRegistry, runtimeParams);
-                    res.type('application/json').send(json);
-                }
-                else {
-                    res.type('application/javascript').send(code);
-                }
-            }
-            else {
-                throw createDiagnostic({ description: errors.SIGNED_MODULE(moduleId.specifier, signature) }, LwrUnresolvableError);
-            }
-        }
-        catch (e) {
-            console.log(e);
-            const error = createReturnStatus(`module "${moduleId?.specifier || req.params?.specifier}"`, e);
-            res.status(error.status).type('text/plain').send(error.message);
-        }
-    });
-    // Unsigned Modules => 302
-    app.get([
-        // Full URL
-        `/:apiVersion/module/:format/:compat/l/:locale/e/:environment/mi/:specifier`,
-        // Without Environment
-        `/:apiVersion/module/:format/:compat/l/:locale/mi/:specifier`,
-        // Without Locale
-        `/:apiVersion/module/:format/:compat/e/:environment/mi/:specifier`,
-        // Without Optional Segments
-        `/:apiVersion/module/:format/:compat/mi/:specifier`,
-    ], async (req, res) => {
-        const ctx = req.getRuntimeContext(defaultRuntimeEnvironment);
-        const targetEnvironment = ctx.runtimeParams.environment;
-        if (!isSupportedEnvironment(environmentConfig, targetEnvironment)) {
-            res.status(400).send({ error: `Environment "${targetEnvironment}" is not supported` });
-            return;
-        }
-        let moduleId;
-        try {
-            ({ moduleId } = getModuleIdentity(req));
-            // Get the importer's specifier via the "importer" query param
-            const importerSpecifier = req.query.importer;
-            if (importerSpecifier) {
-                // Get the importer's file path entry
-                const importerModuleId = explodeSpecifier(importerSpecifier);
-                const { entry } = await moduleRegistry.getModuleEntry(importerModuleId);
-                moduleId = { ...moduleId, importer: entry };
-            }
-            // Get the module's signature from the registry
-            const { ownHash, moduleEntry } = await moduleRegistry.getModule(moduleId, ctx.runtimeParams);
-            if (ownHash) {
-                const jsonQuery = req.isJsonRequest()
-                    ? `${ctx.runtimeEnvironment.debug ? '&' : '?'}json`
-                    : '';
-                const uri = await moduleRegistry.resolveModuleUri({ ...moduleId, version: moduleEntry.version }, ctx.runtimeEnvironment, ctx.runtimeParams, ownHash);
-                res.set({
-                    // This redirects to a signed URI
-                    Location: `${uri}${jsonQuery}`,
-                });
-                res.sendStatus(302);
-            }
-        }
-        catch (e) {
-            console.log(e);
-            const error = createReturnStatus(`module "${moduleId?.specifier || req.params?.specifier}"`, e);
-            res.status(error.status).type('text/plain').send(error.message);
-        }
-    });
-    // Mapping Services
-    // /{apiversion}/mapping/{format}/{compat}(/l/{language})?(/e/{environment})?(/bi/{bundleStrategyId})?/mp/{specifiers}
-    app.get([
-        // Full URL (3 optional segments)
-        `/:apiVersion/mapping/:format/:compat/l/:locale/e/:environment/bi/:bundleSpecifier/mp/:specifiers`,
-        // With 2 optional segments: l & e, l & bi, e & bi
-        `/:apiVersion/mapping/:format/:compat/l/:locale/e/:environment/mp/:specifiers`,
-        `/:apiVersion/mapping/:format/:compat/l/:locale/bi/:bundleSpecifier/mp/:specifiers`,
-        `/:apiVersion/mapping/:format/:compat/e/:environment/bi/:bundleSpecifier/mp/:specifiers`,
-        // With 1 optional segment
-        `/:apiVersion/mapping/:format/:compat/l/:locale/mp/:specifiers`,
-        `/:apiVersion/mapping/:format/:compat/e/:environment/mp/:specifiers`,
-        `/:apiVersion/mapping/:format/:compat/bi/:bundleSpecifier/mp/:specifiers`,
-        // With 0 optional segments
-        `/:apiVersion/mapping/:format/:compat/mp/:specifiers`,
-    ], async (req, res) => {
-        const requestContext = req.getRuntimeContext(defaultRuntimeEnvironment);
-        const targetEnvironment = requestContext.runtimeParams.environment;
-        if (!isSupportedEnvironment(environmentConfig, targetEnvironment)) {
-            res.status(400).send({ error: `Environment "${targetEnvironment}" is not supported` });
-            return;
-        }
-        let moduleIds;
-        try {
-            ({ moduleIds } = getMappingIdentity(req));
-            const { runtimeEnvironment, runtimeParams } = requestContext;
-            const importMetadata = await getImportMetadataMappings(moduleIds, runtimeEnvironment, runtimeParams, moduleRegistry, moduleBundler);
-            // Include import metadata as an object for use with the static site generator
-            res.setMetadata({ importMetadata });
-            // Respond to request
-            res.status(200).type('application/json').send(importMetadata);
-        }
-        catch (e) {
-            console.log(e);
-            const error = createReturnStatus(`mappings for "${JSON.stringify(moduleIds || req.params?.specifiers)}"`, e);
-            res.status(error.status).send(error.message);
-        }
-    });
-    // Resources
-    app.get([
-        // Full URL
-        `/:apiVersion/resource/:format/l/:locale/e/:environment/:specifier`,
-        // Without Environment
-        `/:apiVersion/resource/:format/l/:locale/:specifier`,
-        // Without Locale
-        `/:apiVersion/resource/:format/e/:environment/:specifier`,
-        // Without Optional Segments
-        `/:apiVersion/resource/:format/:specifier`,
-    ], async (req, res) => {
-        const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(defaultRuntimeEnvironment);
-        const targetEnvironment = runtimeParams.environment;
-        if (!isSupportedEnvironment(environmentConfig, targetEnvironment)) {
-            res.status(400).send({ error: `Environment "${targetEnvironment}" is not supported` });
-            return;
-        }
-        let resourceId;
-        try {
-            ({ resourceId } = getResourceIdentity(req));
-            const resource = await resourceRegistry.getResource(resourceId, runtimeEnvironment, runtimeParams);
-            if (resource && resource.content) {
-                // Static resource
-                const type = resource.type === 'text/css' ? resource.type : 'application/javascript';
-                res.type(type).send(resource.content);
-            }
-            else if (resource && resource.stream) {
-                // Stream-able resource
-                res.type(resource.type).stream(resource.stream);
-            }
-            else {
-                throw createDiagnostic({ description: errors.RESOURCE(resourceId.specifier) }, LwrUnresolvableError);
-            }
-            res.setMetadata({ resource });
-        }
-        catch (e) {
-            console.log(e);
-            const error = createReturnStatus(`resource "${resourceId?.specifier || req.params?.specifier}"`, e);
-            res.status(error.status).type('text/plain').send(error.message);
-        }
-    });
-    // -- Asset configuration -----------------------------------------------------------
-    // Custom defined assets
-    const paths = context.appConfig.assets.map((a) => a.urlPath);
-    // Workaround: https://github.com/pillarjs/path-to-regexp#compatibility-with-express--4x
-    // Koa routing (Path-To-RegExp) breaks compatibility with Express routing & asterisk wildcards
-    for (let i = 0; i < paths.length; i++) {
-        paths[i] = paths[i] + app.getRegexWildcard();
-    }
-    app.all(paths, async (req, res) => {
-        const { runtimeEnvironment } = req.getRuntimeContext(defaultRuntimeEnvironment);
-        try {
-            const { assetId: { specifier, type }, signature, } = getAssetIdentity(req);
-            const assetObj = await context.assetRegistry.getAsset({ specifier, signature, type }, runtimeEnvironment);
-            if (assetObj.mime) {
-                res.type(assetObj.mime);
-            }
-            res.setMetadata({ asset: assetObj });
-            res.stream(assetObj.stream());
-        }
-        catch (e) {
-            console.log(e);
-            const error = createReturnStatus(`asset at "${req.originalUrl}"`, e);
-            res.status(error.status).send(error.message);
-        }
-    });
-    // LWR specific assets
-    // Workaround: https://github.com/pillarjs/path-to-regexp#compatibility-with-express--4x
-    // Koa routing (Path-To-RegExp) breaks compatibility with Express routing & asterisk wildcards
-    app.all('/:apiVersion/:assetType/:immutable?/s/:signature/' + app.getRegexWildcard(), async (req, res) => {
-        const { runtimeEnvironment } = req.getRuntimeContext(defaultRuntimeEnvironment);
-        const { basePath } = runtimeEnvironment;
-        const { signature } = req.params;
-        const { immutable, assetType: type } = req.params;
-        const specifier = req.params[0] ? `/${req.params[0]}` : req.originalUrl;
-        const basePathSpecifier = `${basePath}${specifier}`;
-        try {
-            const assetObj = await context.assetRegistry.getAsset({ specifier: basePathSpecifier, signature, type: type }, runtimeEnvironment, req.isSiteGeneration());
-            if (immutable) {
-                // WIP: ?
-            }
-            if (assetObj.mime) {
-                res.type(assetObj.mime);
-            }
-            res.setMetadata({ asset: assetObj });
-            res.stream(assetObj.stream());
-        }
-        catch (e) {
-            console.log(e);
-            const error = createReturnStatus(`asset at "${specifier}"`, e);
-            res.status(error.status).type('text/plain').send(error.message);
-        }
-    });
-}
-//# sourceMappingURL=api-middleware.js.map

package/build/es/middlewares/base-middleware.d.ts

@@ -1,3 +0,0 @@
-import { ServerContext, InternalAppServer, ServerTypes } from '@lwrjs/types';
-export default function baseMiddleware<T extends ServerTypes>(app: InternalAppServer<T>, _context?: ServerContext): void;
-//# sourceMappingURL=base-middleware.d.ts.map

package/build/es/middlewares/base-middleware.js

@@ -1,4 +0,0 @@
-export default function baseMiddleware(app, _context) {
-    app.useCompression();
-}
-//# sourceMappingURL=base-middleware.js.map

package/build/es/middlewares/hmr-middleware.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="node" />
-import http from 'http';
-import { ServerContext } from '@lwrjs/types';
-export default function hmrMiddleware(server: http.Server, context: ServerContext): void;
-//# sourceMappingURL=hmr-middleware.d.ts.map

package/build/es/middlewares/locale-middleware.d.ts

@@ -1,3 +0,0 @@
-import { ServerContext, InternalAppServer, ServerTypes } from '@lwrjs/types';
-export default function localeMiddleware<T extends ServerTypes>(app: InternalAppServer<T>, context: ServerContext): void;
-//# sourceMappingURL=locale-middleware.d.ts.map

package/build/es/middlewares/ui-middleware.d.ts

@@ -1,3 +0,0 @@
-import { ServerContext, InternalAppServer, ServerTypes } from '@lwrjs/types';
-export default function uiMiddleware<T extends ServerTypes>(app: InternalAppServer<T>, context: ServerContext): void;
-//# sourceMappingURL=ui-middleware.d.ts.map

package/build/es/middlewares/ui-middleware.js

@@ -1,186 +0,0 @@
-import ms from 'ms';
-import { DiagnosticsError } from '@lwrjs/diagnostics';
-import { LwrViewHandler } from '@lwrjs/view-registry';
-import { isSupportedEnvironment } from './utils.js';
-import { decodeViewPath, getClientBootstrapConfigurationRoutes, extractRequestParams, } from '@lwrjs/shared-utils';
-import { getClientRoutes } from '@lwrjs/router';
-export default function uiMiddleware(app, context) {
-    const { viewRegistry, moduleRegistry, runtimeEnvironment: defaultRuntimeEnvironment } = context;
-    const { environment: environmentConfig, routes, errorRoutes } = context.appConfig;
-    const route404 = errorRoutes.find((r) => r.status === 404);
-    const route500 = errorRoutes.find((r) => r.status === 500);
-    const viewHandler = new LwrViewHandler({ viewRegistry, moduleRegistry }, context.appConfig);
-    async function sendViewResponse(req, res, route, defaultStatus = 200) {
-        if (!req.validateJsonRequest()) {
-            res.status(400).send({ error: 'Accept header and json query parameter are incompatible' });
-            return;
-        }
-        // UI URIs do not contain bundle IDs, so always use the environment default
-        req.params.bundleSpecifier = defaultRuntimeEnvironment.bundle ? '0' : undefined;
-        const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(defaultRuntimeEnvironment);
-        const targetEnvironment = runtimeParams.environment;
-        if (!isSupportedEnvironment(environmentConfig, targetEnvironment)) {
-            res.status(400).send({ error: `Environment "${targetEnvironment}" is not supported` });
-            return;
-        }
-        if (!targetEnvironment && environmentConfig?.default) {
-            runtimeParams.environment = environmentConfig.default;
-        }
-        try {
-            // HTML document
-            const viewRequest = {
-                url: req.originalUrl,
-                params: req.params,
-                query: req.query,
-                requestPath: req.path, // Runtime resolved version vs. the original route path
-            };
-            const response = req.isJsonRequest()
-                ? await viewHandler.getViewJson(viewRequest, route, runtimeEnvironment, runtimeParams)
-                : await viewHandler.getViewContent(viewRequest, route, runtimeEnvironment, runtimeParams);
-            const cacheTtl = response.cache?.ttl || route.cache?.ttl;
-            let ttl;
-            if (cacheTtl) {
-                ttl = typeof cacheTtl === 'string' ? ms(cacheTtl) / 1000 : cacheTtl;
-                res.setHeader('Cache-control', `public, max-age=${ttl}`);
-            }
-            const headers = response.headers || {
-                'Content-Type': 'text/html',
-                ...(cacheTtl && { 'Cache-control': `public, max-age=${ttl}` }),
-            };
-            res.set(headers);
-            res.setMetadata(response.metadata);
-            const status = response.status ? response.status : defaultStatus;
-            res.status(status).send(response.body);
-        }
-        catch (error) {
-            if (error instanceof DiagnosticsError) {
-                console.error('LWR Diagnostic Error: ' + error.message);
-                console.error(error.diagnostics);
-                console.error(error.stack);
-            }
-            else {
-                console.error(error);
-            }
-            if (route500 && defaultStatus !== 500) {
-                await sendViewResponse(req, res, route500, 500);
-            }
-            else {
-                res.status(500).send(`500 - Error retrieving view for route "${route.id}"`);
-            }
-        }
-    }
-    async function sendConfigurationResponse(req, res, defaultStatus = 200) {
-        // UI URIs do not contain bundle IDs, so always use the environment default
-        req.params.bundleSpecifier = defaultRuntimeEnvironment.bundle ? '0' : undefined;
-        const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(defaultRuntimeEnvironment);
-        const { appId, encodedViewPath } = req.params;
-        // Match the route id
-        const route = routes.find((route) => route.id === appId);
-        if (!route) {
-            res.status(404).send({ error: `LWR configuration for appId "${appId}" is not available` });
-            return;
-        }
-        try {
-            // decode the resolved view path and extract any params.
-            const url = decodeViewPath(encodedViewPath);
-            const requestPath = route.path;
-            const params = extractRequestParams(requestPath, url, req.params);
-            // HTML document
-            const viewRequest = {
-                url,
-                params,
-                query: req.query,
-                requestPath, // Runtime resolved version vs. the original route path
-            };
-            const response = await viewHandler.getViewConfiguration(viewRequest, route, runtimeEnvironment, runtimeParams);
-            if (!response) {
-                res.status(404).send({ error: `LWR configuration for viewPath "${url}" is not available` });
-                return;
-            }
-            // Same cache ttl as the Content response
-            const cacheTtl = response.cache?.ttl || route.cache?.ttl;
-            let ttl;
-            if (cacheTtl) {
-                ttl = typeof cacheTtl === 'string' ? ms(cacheTtl) / 1000 : cacheTtl;
-            }
-            res.set({
-                'Content-Type': 'application/javascript',
-                ...(cacheTtl && { 'Cache-control': `public, max-age=${ttl}` }),
-            });
-            const status = response.status ? response.status : defaultStatus;
-            res.status(status).send(response.body);
-        }
-        catch (error) {
-            if (error instanceof DiagnosticsError) {
-                console.error('LWR Diagnostic Error: ' + error.message);
-                console.error(error.diagnostics);
-                console.error(error.stack);
-            }
-            else {
-                console.error(error);
-            }
-            if (route500 && defaultStatus !== 500) {
-                await sendViewResponse(req, res, route500, 500);
-            }
-            else {
-                res.status(500).send(`500 - Error retrieving route "${route.id}"`);
-            }
-        }
-    }
-    // -- Register each view ------------------------------------------------------------
-    routes.forEach((route) => {
-        // Seems like we only support get or post
-        if (route.method === 'post') {
-            app.post(route.path, async (req, res) => {
-                await sendViewResponse(req, res, route);
-            });
-        }
-        else {
-            // Get the client-side routes
-            const serverPath = route.path;
-            const paths = [serverPath];
-            const subRoutes = route.subRoutes ? getClientRoutes(route.subRoutes) : undefined;
-            if (subRoutes) {
-                // Concatenate each client uri to the server route.path, creating the full list of composite paths
-                const prefix = serverPath === '/' ? '' : serverPath;
-                subRoutes.routes.forEach((r) => paths.push(`${prefix}${r.uri}`));
-            }
-            // Register the server route.path and each composite client path, to enable full page refreshes of client pages
-            paths.forEach((path) => {
-                // vanity urls
-                app.get(path, async (req, res) => {
-                    await sendViewResponse(req, res, route);
-                });
-                // canonical URL
-                app.get([
-                    `/:apiVersion/application/:format/l/:locale/ai/:appId${path}`,
-                    `/:apiVersion/application/:format/l/:locale/e/:environment/ai/:appId${path}`,
-                    `/:apiVersion/application/:format/ai/:appId${path}`,
-                    `/:apiVersion/application/:format/e/:environment/ai/:appId${path}`,
-                ], async (req, res) => {
-                    await sendViewResponse(req, res, route);
-                });
-            });
-        }
-    });
-    const clientBootstrapConfigurationRoutes = getClientBootstrapConfigurationRoutes();
-    app.get(clientBootstrapConfigurationRoutes, async (req, res) => {
-        await sendConfigurationResponse(req, res);
-    });
-    // TODO nrkruk - This needs to be more generalized and visible at the top level of our middleware code.
-    // This is the only time we call initRoutes() - which adds all the routing middleware that has been declared previously
-    // to the app (get()/post()/all()). Any routing middleware declared after this point will not be initialized
-    // (for KOA and other server types where routing is not included in the base package).
-    // NOTE: THIS MUST BE ALWAYS CALLED BEFORE THE DEFAULT 404 ROUTE BELOW
-    app.initRoutes();
-    // -- Default 404 route -------------------------------------------------------------
-    app.use(async (req, res) => {
-        if (route404) {
-            await sendViewResponse(req, res, route404, 404);
-        }
-        else {
-            res.status(404).send('404 - This page does not exist');
-        }
-    });
-}
-//# sourceMappingURL=ui-middleware.js.map

package/build/es/middlewares/utils.d.ts

@@ -1,22 +0,0 @@
-/// <reference types="node" />
-import http from 'http';
-import { EnvironmentConfig } from '@lwrjs/types';
-import qs from 'qs';
-interface Params {
-    [key: string]: string;
-}
-export declare function getRequestProperties(pattern: string, req: http.IncomingMessage): {
-    url: string;
-    params: Params;
-    query: qs.ParsedQs;
-} | undefined;
-/**
- * Check if the target environment is supported by the application
- *
- * @param environmentConfig - environment property from app config
- * @param targetEnvironment - environment value from module uri
- * @returns boolean
- */
-export declare function isSupportedEnvironment(environmentConfig: EnvironmentConfig, targetEnvironment: string): boolean;
-export {};
-//# sourceMappingURL=utils.d.ts.map