@squiz/render-runtime-lib 1.73.0 → 1.75.0

package/lib/webserver/controllers/DefinitionController.js

@@ -0,0 +1,162 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var DefinitionController_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefinitionController = void 0;
+const tsoa_1 = require("tsoa");
+const inversify_1 = require("inversify");
+const inversify_binding_decorators_1 = require("inversify-binding-decorators");
+const dx_common_lib_1 = require("@squiz/dx-common-lib");
+const component_lib_1 = require("@squiz/component-lib");
+const setHeadersOnExpressResponse_1 = require("../../utils/setHeadersOnExpressResponse");
+let DefinitionController = DefinitionController_1 = class DefinitionController extends tsoa_1.Controller {
+    constructor(componentSetService, manifestService, componentFunctionService, componentRootUrlResolver) {
+        super();
+        this.componentSetService = componentSetService;
+        this.manifestService = manifestService;
+        this.componentFunctionService = componentFunctionService;
+        this.componentRootUrlResolver = componentRootUrlResolver;
+    }
+    async getComponentVersionManifest(namespace, componentName, version, request, _previewKey, _componentSet) {
+        const response = request.res;
+        (0, dx_common_lib_1.assertIsDefined)(response);
+        this.assertValidQueryParametersForDefinition(_previewKey, _componentSet);
+        const rootUrl = this.componentRootUrlResolver(request);
+        const manifest = await this.manifestService.loadManifest(namespace, componentName, version);
+        if (_previewKey !== undefined) {
+            return this.componentFunctionService.prepareManifestForPreview(manifest, _previewKey, rootUrl);
+        }
+        if (_componentSet !== undefined) {
+            await this.setHeadersFromComponentSet(manifest, _componentSet, response);
+            return this.componentFunctionService.prepareManifestForWebResponse(manifest, _componentSet, rootUrl);
+        }
+        return manifest.getModel();
+    }
+    async getDefaultFunctionDefinition(namespace, componentName, version, request, _previewKey, _componentSet) {
+        const response = request.res;
+        (0, dx_common_lib_1.assertIsDefined)(response);
+        this.assertValidQueryParametersForDefinition(_previewKey, _componentSet);
+        const rootUrl = this.componentRootUrlResolver(request);
+        const manifest = await this.manifestService.loadManifest(namespace, componentName, version);
+        const manifestModel = manifest.getModel();
+        const result = this.componentFunctionService.getFunctionDefinitionFromManifest(manifestModel.mainFunction, manifest);
+        if (!result) {
+            throw new dx_common_lib_1.ResourceNotFoundError(`${manifestModel.mainFunction} could not be found in ${componentName} ${version}`);
+        }
+        if (_previewKey !== undefined) {
+            this.setHeadersFromPreview(manifest, _previewKey, manifestModel.mainFunction, response);
+            return this.componentFunctionService.prepareComponentFunctionForPreview(result, manifest, _previewKey, rootUrl);
+        }
+        if (_componentSet !== undefined) {
+            await this.setHeadersFromComponentSet(manifest, _componentSet, response);
+            return this.componentFunctionService.prepareComponentFunctionForWebResponse(result, manifest, _componentSet, rootUrl);
+        }
+        return result;
+    }
+    async getGivenFunctionDefinition(namespace, componentName, version, functionName, request, _previewKey, _componentSet) {
+        const response = request.res;
+        (0, dx_common_lib_1.assertIsDefined)(response);
+        this.assertValidQueryParametersForDefinition(_previewKey, _componentSet);
+        const rootUrl = this.componentRootUrlResolver(request);
+        const manifest = await this.manifestService.loadManifest(namespace, componentName, version);
+        const result = this.componentFunctionService.getFunctionDefinitionFromManifest(functionName, manifest);
+        if (!result) {
+            throw new dx_common_lib_1.ResourceNotFoundError(`${functionName} could not be found in ${componentName} ${version}`);
+        }
+        if (_previewKey !== undefined) {
+            this.setHeadersFromPreview(manifest, _previewKey, functionName, response);
+            return this.componentFunctionService.prepareComponentFunctionForPreview(result, manifest, _previewKey, rootUrl);
+        }
+        if (_componentSet !== undefined) {
+            await this.setHeadersFromComponentSet(manifest, _componentSet, response);
+            return this.componentFunctionService.prepareComponentFunctionForWebResponse(result, manifest, _componentSet, rootUrl);
+        }
+        return result;
+    }
+    async setHeadersFromComponentSet(manifest, componentSet, response) {
+        const set = await this.componentSetService.getComponentSet(componentSet);
+        const componentName = manifest.getName();
+        const version = manifest.getVersion();
+        const isCompVersionInSet = await this.componentSetService.componentVersionInSet(manifest, set.webPath);
+        if (!isCompVersionInSet) {
+            throw new dx_common_lib_1.ResourceNotFoundError(`${componentName} ${version} not in set ${set.webPath}`);
+        }
+        this.setHeaders((set === null || set === void 0 ? void 0 : set.headers) || {}, response);
+    }
+    setHeadersFromPreview(manifest, _previewKey, functionName, response) {
+        const previewConfig = manifest.getFunctionPreviewConfiguration(_previewKey, manifest.getComponentFunctionByName(functionName));
+        this.setHeaders((previewConfig === null || previewConfig === void 0 ? void 0 : previewConfig.headers) || {}, response);
+    }
+    setHeaders(headers, response) {
+        (0, setHeadersOnExpressResponse_1.setHeadersOnExpressResponse)(headers, response);
+        let cacheControl = response.getHeader('cache-control');
+        if (typeof cacheControl !== 'string') {
+            cacheControl = undefined;
+        }
+        response.setHeader('cache-control', (0, dx_common_lib_1.parseAndSanitiseCacheControlHeader)(cacheControl));
+    }
+    assertValidQueryParametersForDefinition(_previewKey, _componentSet) {
+        if (_previewKey !== undefined && _componentSet !== undefined) {
+            throw new dx_common_lib_1.BadRequestError('You can not have both a _componentSet and _previewKey');
+        }
+    }
+};
+__decorate([
+    (0, tsoa_1.Get)('/:namespace/:componentName/:version/manifest.json'),
+    __param(0, (0, tsoa_1.Path)()),
+    __param(1, (0, tsoa_1.Path)()),
+    __param(2, (0, tsoa_1.Path)()),
+    __param(3, (0, tsoa_1.Request)()),
+    __param(4, (0, tsoa_1.Query)()),
+    __param(5, (0, tsoa_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, String, Object, String, String]),
+    __metadata("design:returntype", Promise)
+], DefinitionController.prototype, "getComponentVersionManifest", null);
+__decorate([
+    (0, tsoa_1.Get)('/:namespace/:componentName/:version'),
+    __param(0, (0, tsoa_1.Path)()),
+    __param(1, (0, tsoa_1.Path)()),
+    __param(2, (0, tsoa_1.Path)()),
+    __param(3, (0, tsoa_1.Request)()),
+    __param(4, (0, tsoa_1.Query)()),
+    __param(5, (0, tsoa_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, String, Object, String, String]),
+    __metadata("design:returntype", Promise)
+], DefinitionController.prototype, "getDefaultFunctionDefinition", null);
+__decorate([
+    (0, tsoa_1.Get)('/:namespace/:componentName/:version/:functionName'),
+    __param(0, (0, tsoa_1.Path)()),
+    __param(1, (0, tsoa_1.Path)()),
+    __param(2, (0, tsoa_1.Path)()),
+    __param(3, (0, tsoa_1.Path)()),
+    __param(4, (0, tsoa_1.Request)()),
+    __param(5, (0, tsoa_1.Query)()),
+    __param(6, (0, tsoa_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, String, String, Object, String, String]),
+    __metadata("design:returntype", Promise)
+], DefinitionController.prototype, "getGivenFunctionDefinition", null);
+DefinitionController = DefinitionController_1 = __decorate([
+    (0, inversify_binding_decorators_1.provide)(DefinitionController_1),
+    (0, tsoa_1.Route)('/d'),
+    __param(0, (0, inversify_1.inject)('ComponentSetService')),
+    __param(1, (0, inversify_1.inject)('ManifestService')),
+    __param(2, (0, inversify_1.inject)('ComponentFunctionService')),
+    __param(3, (0, inversify_1.inject)('ComponentRootUrlResolver')),
+    __metadata("design:paramtypes", [Object, Object, component_lib_1.ComponentFunctionService, Object])
+], DefinitionController);
+exports.DefinitionController = DefinitionController;
+//# sourceMappingURL=DefinitionController.js.map

package/lib/webserver/controllers/DefinitionController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefinitionController.js","sourceRoot":"","sources":["../../../src/webserver/controllers/DefinitionController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+BAAoE;AACpE,yCAAmC;AACnC,+EAAuD;AAEvD,wDAK8B;AAC9B,wDAQ8B;AAC9B,yFAAsF;AAK/E,IAAM,oBAAoB,4BAA1B,MAAM,oBAAqB,SAAQ,iBAAU;IAClD,YAC2C,mBAAwC,EAC5C,eAAgC,EACvB,wBAAkD,EAClD,wBAAkD;QAEhG,KAAK,EAAE,CAAC;QALiC,wBAAmB,GAAnB,mBAAmB,CAAqB;QAC5C,oBAAe,GAAf,eAAe,CAAiB;QACvB,6BAAwB,GAAxB,wBAAwB,CAA0B;QAClD,6BAAwB,GAAxB,wBAAwB,CAA0B;IAGlG,CAAC;IAGY,AAAN,KAAK,CAAC,2BAA2B,CAC9B,SAAiB,EACjB,aAAqB,EACrB,OAAe,EACZ,OAAuB,EACzB,WAAoB,EACpB,aAAsB;QAE/B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;QAC7B,IAAA,+BAAe,EAAC,QAAQ,CAAC,CAAC;QAE1B,IAAI,CAAC,uCAAuC,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,SAAS,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;QAE5F,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,OAAO,IAAI,CAAC,wBAAwB,CAAC,yBAAyB,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;SAChG;QAED,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,MAAM,IAAI,CAAC,0BAA0B,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC,wBAAwB,CAAC,6BAA6B,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;SACtG;QAED,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAGY,AAAN,KAAK,CAAC,4BAA4B,CAC/B,SAAiB,EACjB,aAAqB,EACrB,OAAe,EAEZ,OAAuB,EAEzB,WAAoB,EACpB,aAAsB;QAE/B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;QAC7B,IAAA,+BAAe,EAAC,QAAQ,CAAC,CAAC;QAC1B,IAAI,CAAC,uCAAuC,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,SAAS,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;QAC5F,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,wBAAwB,CAAC,iCAAiC,CAC5E,aAAa,CAAC,YAAY,EAC1B,QAAQ,CACT,CAAC;QAEF,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,qCAAqB,CAC7B,GAAG,aAAa,CAAC,YAAY,0BAA0B,aAAa,IAAI,OAAO,EAAE,CAClF,CAAC;SACH;QAED,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,WAAW,EAAE,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YACxF,OAAO,IAAI,CAAC,wBAAwB,CAAC,kCAAkC,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;SACjH;QAED,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,MAAM,IAAI,CAAC,0BAA0B,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC,wBAAwB,CAAC,sCAAsC,CACzE,MAAM,EACN,QAAQ,EACR,aAAa,EACb,OAAO,CACR,CAAC;SACH;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAGY,AAAN,KAAK,CAAC,0BAA0B,CAC7B,SAAiB,EACjB,aAAqB,EACrB,OAAe,EACf,YAAoB,EACjB,OAAuB,EACzB,WAAoB,EACpB,aAAsB;QAE/B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;QAC7B,IAAA,+BAAe,EAAC,QAAQ,CAAC,CAAC;QAE1B,IAAI,CAAC,uCAAuC,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,SAAS,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;QAE5F,MAAM,MAAM,GAAG,IAAI,CAAC,wBAAwB,CAAC,iCAAiC,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAEvG,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,qCAAqB,CAAC,GAAG,YAAY,0BAA0B,aAAa,IAAI,OAAO,EAAE,CAAC,CAAC;SACtG;QAED,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;YAC1E,OAAO,IAAI,CAAC,wBAAwB,CAAC,kCAAkC,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;SACjH;QAED,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,MAAM,IAAI,CAAC,0BAA0B,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC,wBAAwB,CAAC,sCAAsC,CACzE,MAAM,EACN,QAAQ,EACR,aAAa,EACb,OAAO,CACR,CAAC;SACH;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAAC,QAAkB,EAAE,YAAoB,EAAE,QAAyB;QAC1G,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACzE,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,EAAE,CAAC;QACtC,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QAEvG,IAAI,CAAC,kBAAkB,EAAE;YACvB,MAAM,IAAI,qCAAqB,CAAC,GAAG,aAAa,IAAI,OAAO,eAAe,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;SAC1F;QAED,IAAI,CAAC,UAAU,CAAC,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,KAAI,EAAE,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;IAES,qBAAqB,CAC7B,QAAkB,EAClB,WAAmB,EACnB,YAAoB,EACpB,QAAyB;QAEzB,MAAM,aAAa,GAAG,QAAQ,CAAC,+BAA+B,CAC5D,WAAW,EACX,QAAQ,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAClD,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,KAAI,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAES,UAAU,CAAC,OAAgB,EAAE,QAAyB;QAC9D,IAAA,yDAA2B,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAE/C,IAAI,YAAY,GAAG,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAEvD,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;YACpC,YAAY,GAAG,SAAS,CAAC;SAC1B;QAED,QAAQ,CAAC,SAAS,CAAC,eAAe,EAAE,IAAA,kDAAkC,EAAC,YAAY,CAAC,CAAC,CAAC;IACxF,CAAC;IAES,uCAAuC,CAC/C,WAA+B,EAC/B,aAAiC;QAEjC,IAAI,WAAW,KAAK,SAAS,IAAI,aAAa,KAAK,SAAS,EAAE;YAC5D,MAAM,IAAI,+BAAe,CAAC,uDAAuD,CAAC,CAAC;SACpF;IACH,CAAC;CACF,CAAA;AAjKc;IADZ,IAAA,UAAG,EAAC,mDAAmD,CAAC;IAEtD,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,cAAO,GAAE,CAAA;IACT,WAAA,IAAA,YAAK,GAAE,CAAA;IACP,WAAA,IAAA,YAAK,GAAE,CAAA;;;;uEAmBT;AAGY;IADZ,IAAA,UAAG,EAAC,qCAAqC,CAAC;IAExC,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IAEN,WAAA,IAAA,cAAO,GAAE,CAAA;IAET,WAAA,IAAA,YAAK,GAAE,CAAA;IACP,WAAA,IAAA,YAAK,GAAE,CAAA;;;;wEAoCT;AAGY;IADZ,IAAA,UAAG,EAAC,mDAAmD,CAAC;IAEtD,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,cAAO,GAAE,CAAA;IACT,WAAA,IAAA,YAAK,GAAE,CAAA;IACP,WAAA,IAAA,YAAK,GAAE,CAAA;;;;sEA8BT;AA3HU,oBAAoB;IAFhC,IAAA,sCAAO,EAAC,sBAAoB,CAAC;IAC7B,IAAA,YAAK,EAAC,IAAI,CAAC;IAGP,WAAA,IAAA,kBAAM,EAAC,qBAAqB,CAAC,CAAA;IAC7B,WAAA,IAAA,kBAAM,EAAC,iBAAiB,CAAC,CAAA;IACzB,WAAA,IAAA,kBAAM,EAAC,0BAA0B,CAAC,CAAA;IAClC,WAAA,IAAA,kBAAM,EAAC,0BAA0B,CAAC,CAAA;qDADqC,wCAAwB;GAJvF,oBAAoB,CA4KhC;AA5KY,oDAAoB"}

package/lib/webserver/controllers/DefinitionController.spec.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_helpers_1 = require("../../test-helpers");
+const definition_route_tests_1 = require("./test/definition-route-tests");
+describe('render-runtime - component definitions', () => {
+    let server;
+    beforeAll(() => {
+        server = new test_helpers_1.TestHelpers.TestServer();
+        server.start();
+    });
+    afterAll(() => {
+        server.stop();
+    });
+    (0, definition_route_tests_1.definitionRouteTests)(() => server.request);
+});
+//# sourceMappingURL=DefinitionController.spec.js.map

package/lib/webserver/controllers/DefinitionController.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefinitionController.spec.js","sourceRoot":"","sources":["../../../src/webserver/controllers/DefinitionController.spec.ts"],"names":[],"mappings":";;AAAA,qDAAiD;AACjD,0EAAqE;AAErE,QAAQ,CAAC,wCAAwC,EAAE,GAAG,EAAE;IACtD,IAAI,MAA8B,CAAC;IACnC,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,GAAG,IAAI,0BAAW,CAAC,UAAU,EAAE,CAAC;QACtC,MAAM,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,GAAG,EAAE;QACZ,MAAM,CAAC,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,IAAA,6CAAoB,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC,CAAC,CAAC"}

package/lib/webserver/controllers/DevelopmentController.js

@@ -0,0 +1,149 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var DevelopmentController_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DevelopmentController = void 0;
+const tsoa_1 = require("tsoa");
+const inversify_binding_decorators_1 = require("inversify-binding-decorators");
+const inversify_1 = require("inversify");
+const dx_common_lib_1 = require("@squiz/dx-common-lib");
+const setHeadersOnExpressResponse_1 = require("../../utils/setHeadersOnExpressResponse");
+let DevelopmentController = DevelopmentController_1 = class DevelopmentController extends tsoa_1.Controller {
+    constructor(config, manifestService, componentRunnerService) {
+        super();
+        this.config = config;
+        this.manifestService = manifestService;
+        this.componentRunnerService = componentRunnerService;
+    }
+    async getComponents() {
+        if (!this.config.enableDevMode) {
+            throw new dx_common_lib_1.ResourceNotFoundError('Route does not exist.');
+        }
+        const components = await this.manifestService.listAllComponentManifests();
+        return components.map((component) => component.getModel());
+    }
+    async Manifest(namespace, componentName, version) {
+        if (!this.config.enableDevMode) {
+            throw new dx_common_lib_1.ResourceNotFoundError('Route does not exist.');
+        }
+        const manifest = await this.manifestService.loadManifest(namespace, componentName, version);
+        return manifest.getModel();
+    }
+    async getContentSchema(namespace, componentName, version) {
+        if (!this.config.enableDevMode) {
+            throw new dx_common_lib_1.ResourceNotFoundError('Route does not exist.');
+        }
+        const componentManifest = await this.manifestService.loadManifest(namespace, componentName, version);
+        const inputSchemas = componentManifest.getInputSchemas();
+        const schemaResult = [];
+        inputSchemas.forEach((inputSchema) => {
+            if (inputSchema.schema && Object.keys(inputSchema.schema).length) {
+                schemaResult.push(inputSchema);
+            }
+        });
+        return schemaResult;
+    }
+    async TemporaryPreview(req, namespace, componentName, version, functionName, 
+    // With types on the below, we get error: @Query('headers') Can't support refAlias type
+    headers, envVars, data) {
+        if (!this.config.enableDevMode) {
+            throw new dx_common_lib_1.ResourceNotFoundError('Route does not exist.');
+        }
+        const res = req.res;
+        const componentSet = {
+            environment: envVars !== null && envVars !== void 0 ? envVars : {},
+            displayName: componentName,
+            webPath: 'mock-set',
+        };
+        const rootUrl = `http://${req.headers.host}`.replace(/\/+$/, '');
+        const componentManifest = await this.manifestService.loadManifest(namespace, componentName, version);
+        const componentFunction = componentManifest.getComponentFunctionByName(functionName);
+        const result = await this.componentRunnerService.executeComponentFunction({
+            dxpApiKey: undefined,
+            requestId: 'MOCK_ME',
+            args: [data],
+            functionEntryFilePath: await componentManifest.getComponentFunctionEntryFilePath(componentFunction),
+            environment: componentSet.environment,
+            componentFullName: componentName,
+            componentFunction: componentFunction,
+            componentRootUrl: rootUrl,
+            manifest: componentManifest.getModel(),
+            runtimeSet: componentSet,
+            manifestPath: await componentManifest.getManifestPath(),
+            previewKey: undefined,
+            queryParameters: undefined,
+        });
+        const responseHeaders = headers !== null && headers !== void 0 ? headers : {};
+        switch (componentFunction.output.responseType) {
+            case 'html':
+                responseHeaders['content-type'] = 'text/html';
+                break;
+            case 'json':
+                responseHeaders['content-type'] = 'application/json';
+                break;
+        }
+        (0, setHeadersOnExpressResponse_1.setHeadersOnExpressResponse)(responseHeaders !== null && responseHeaders !== void 0 ? responseHeaders : {}, res);
+        res.send(result);
+    }
+};
+__decorate([
+    (0, tsoa_1.Get)('/all'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], DevelopmentController.prototype, "getComponents", null);
+__decorate([
+    (0, tsoa_1.Get)('/manifest/:namespace/:componentName/:version'),
+    __param(0, (0, tsoa_1.Path)()),
+    __param(1, (0, tsoa_1.Path)()),
+    __param(2, (0, tsoa_1.Path)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, String]),
+    __metadata("design:returntype", Promise)
+], DevelopmentController.prototype, "Manifest", null);
+__decorate([
+    (0, tsoa_1.Get)('/schemas/:namespace/:componentName/:version'),
+    __param(0, (0, tsoa_1.Path)()),
+    __param(1, (0, tsoa_1.Path)()),
+    __param(2, (0, tsoa_1.Path)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, String]),
+    __metadata("design:returntype", Promise)
+], DevelopmentController.prototype, "getContentSchema", null);
+__decorate([
+    (0, tsoa_1.Get)('/temp-preview/:namespace/:componentName/:version/:functionName'),
+    (0, tsoa_1.Produces)('text/html'),
+    __param(0, (0, tsoa_1.Request)()),
+    __param(1, (0, tsoa_1.Path)()),
+    __param(2, (0, tsoa_1.Path)()),
+    __param(3, (0, tsoa_1.Path)()),
+    __param(4, (0, tsoa_1.Path)()),
+    __param(5, (0, tsoa_1.Query)()),
+    __param(6, (0, tsoa_1.Query)()),
+    __param(7, (0, tsoa_1.Query)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, String, String, String, String, Object, Object, Object]),
+    __metadata("design:returntype", Promise)
+], DevelopmentController.prototype, "TemporaryPreview", null);
+DevelopmentController = DevelopmentController_1 = __decorate([
+    (0, inversify_binding_decorators_1.provide)(DevelopmentController_1),
+    (0, tsoa_1.Route)('/dev'),
+    (0, tsoa_1.Hidden)(),
+    __param(0, (0, inversify_1.inject)('Config')),
+    __param(1, (0, inversify_1.inject)('ManifestService')),
+    __param(2, (0, inversify_1.inject)('ComponentRunnerService')),
+    __metadata("design:paramtypes", [Object, Object, Object])
+], DevelopmentController);
+exports.DevelopmentController = DevelopmentController;
+//# sourceMappingURL=DevelopmentController.js.map

package/lib/webserver/controllers/DevelopmentController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevelopmentController.js","sourceRoot":"","sources":["../../../src/webserver/controllers/DevelopmentController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+BAAsF;AACtF,+EAAuD;AACvD,yCAAmC;AAEnC,wDAA6D;AAK7D,yFAAsF;AAQ/E,IAAM,qBAAqB,6BAA3B,MAAM,qBAAsB,SAAQ,iBAAU;IACnD,YAC4B,MAAc,EACL,eAAgC,EACzB,sBAA8C;QAExF,KAAK,EAAE,CAAC;QAJkB,WAAM,GAAN,MAAM,CAAQ;QACL,oBAAe,GAAf,eAAe,CAAiB;QACzB,2BAAsB,GAAtB,sBAAsB,CAAwB;IAG1F,CAAC;IAGY,AAAN,KAAK,CAAC,aAAa;QACxB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YAC9B,MAAM,IAAI,qCAAqB,CAAC,uBAAuB,CAAC,CAAC;SAC1D;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,yBAAyB,EAAE,CAAC;QAC1E,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC7D,CAAC;IAGY,AAAN,KAAK,CAAC,QAAQ,CACX,SAAiB,EACjB,aAAqB,EACrB,OAAe;QAEvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YAC9B,MAAM,IAAI,qCAAqB,CAAC,uBAAuB,CAAC,CAAC;SAC1D;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,SAAS,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;QAC5F,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAGY,AAAN,KAAK,CAAC,gBAAgB,CACnB,SAAiB,EACjB,aAAqB,EACrB,OAAe;QAEvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YAC9B,MAAM,IAAI,qCAAqB,CAAC,uBAAuB,CAAC,CAAC;SAC1D;QAED,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,SAAS,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;QACrG,MAAM,YAAY,GAAG,iBAAiB,CAAC,eAAe,EAAE,CAAC;QACzD,MAAM,YAAY,GAAsB,EAAE,CAAC;QAC3C,YAAY,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YACnC,IAAI,WAAW,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE;gBAChE,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;aAChC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,YAAY,CAAC;IACtB,CAAC;IAIY,AAAN,KAAK,CAAC,gBAAgB,CAChB,GAAmB,EACtB,SAAiB,EACjB,aAAqB,EACrB,OAAe,EACf,YAAoB;IAC5B,uFAAuF;IAC9E,OAAa,EACb,OAAa,EACb,IAAU;QAEnB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;YAC9B,MAAM,IAAI,qCAAqB,CAAC,uBAAuB,CAAC,CAAC;SAC1D;QAED,MAAM,GAAG,GAAG,GAAG,CAAC,GAAsB,CAAC;QAEvC,MAAM,YAAY,GAAG;YACnB,WAAW,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE;YAC1B,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,UAAU;SACpB,CAAC;QAEF,MAAM,OAAO,GAAG,UAAU,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACjE,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,SAAS,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;QAErG,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;QAErF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,wBAAwB,CAAC;YACxE,SAAS,EAAE,SAAS;YACpB,SAAS,EAAE,SAAS;YACpB,IAAI,EAAE,CAAC,IAAI,CAAC;YACZ,qBAAqB,EAAE,MAAM,iBAAiB,CAAC,iCAAiC,CAAC,iBAAiB,CAAC;YACnG,WAAW,EAAE,YAAY,CAAC,WAAW;YACrC,iBAAiB,EAAE,aAAa;YAChC,iBAAiB,EAAE,iBAAiB;YACpC,gBAAgB,EAAE,OAAO;YACzB,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,EAAE;YACtC,UAAU,EAAE,YAAY;YACxB,YAAY,EAAE,MAAM,iBAAiB,CAAC,eAAe,EAAE;YACvD,UAAU,EAAE,SAAS;YACrB,eAAe,EAAE,SAAS;SAC3B,CAAC,CAAC;QAEH,MAAM,eAAe,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACtC,QAAQ,iBAAiB,CAAC,MAAM,CAAC,YAAY,EAAE;YAC7C,KAAK,MAAM;gBACT,eAAe,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;gBAC9C,MAAM;YACR,KAAK,MAAM;gBACT,eAAe,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;gBACrD,MAAM;SACT;QAED,IAAA,yDAA2B,EAAC,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,EAAE,EAAE,GAAG,CAAC,CAAC;QACxD,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnB,CAAC;CACF,CAAA;AAvGc;IADZ,IAAA,UAAG,EAAC,MAAM,CAAC;;;;0DAQX;AAGY;IADZ,IAAA,UAAG,EAAC,8CAA8C,CAAC;IAEjD,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;;;;qDAQR;AAGY;IADZ,IAAA,UAAG,EAAC,6CAA6C,CAAC;IAEhD,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;;;;6DAeR;AAIY;IAFZ,IAAA,UAAG,EAAC,gEAAgE,CAAC;IACrE,IAAA,eAAQ,EAAC,WAAW,CAAC;IAEnB,WAAA,IAAA,cAAO,GAAE,CAAA;IACT,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IACN,WAAA,IAAA,WAAI,GAAE,CAAA;IAEN,WAAA,IAAA,YAAK,GAAE,CAAA;IACP,WAAA,IAAA,YAAK,GAAE,CAAA;IACP,WAAA,IAAA,YAAK,GAAE,CAAA;;;;6DA+CT;AAhHU,qBAAqB;IAHjC,IAAA,sCAAO,EAAC,uBAAqB,CAAC;IAC9B,IAAA,YAAK,EAAC,MAAM,CAAC;IACb,IAAA,aAAM,GAAE;IAGJ,WAAA,IAAA,kBAAM,EAAC,QAAQ,CAAC,CAAA;IAChB,WAAA,IAAA,kBAAM,EAAC,iBAAiB,CAAC,CAAA;IACzB,WAAA,IAAA,kBAAM,EAAC,wBAAwB,CAAC,CAAA;;GAJxB,qBAAqB,CAiHjC;AAjHY,sDAAqB"}

package/lib/webserver/controllers/DevelopmentController.spec.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_1 = require("../../test");
+const development_route_tests_1 = require("./test/development-route-tests");
+describe('DevelopmentController', () => {
+    describe('development mode enabled', () => {
+        let server;
+        beforeAll(() => {
+            server = new test_1.TestServer({}, { enableDevMode: true });
+            server.start();
+        });
+        afterAll(() => {
+            server.stop();
+        });
+        (0, development_route_tests_1.developmentRouteTests)(() => server.request, true);
+    });
+    describe('development mode disabled', () => {
+        let server;
+        beforeAll(() => {
+            server = new test_1.TestServer({}, { enableDevMode: false });
+            server.start();
+        });
+        afterAll(() => {
+            server.stop();
+        });
+        (0, development_route_tests_1.developmentRouteTests)(() => server.request, false);
+    });
+});
+//# sourceMappingURL=DevelopmentController.spec.js.map

package/lib/webserver/controllers/DevelopmentController.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevelopmentController.spec.js","sourceRoot":"","sources":["../../../src/webserver/controllers/DevelopmentController.spec.ts"],"names":[],"mappings":";;AAAA,qCAAwC;AACxC,4EAAuE;AAEvE,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACxC,IAAI,MAAkB,CAAC;QACvB,SAAS,CAAC,GAAG,EAAE;YACb,MAAM,GAAG,IAAI,iBAAU,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YACrD,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,GAAG,EAAE;YACZ,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,IAAA,+CAAqB,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACzC,IAAI,MAAkB,CAAC;QACvB,SAAS,CAAC,GAAG,EAAE;YACb,MAAM,GAAG,IAAI,iBAAU,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;YACtD,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,GAAG,EAAE;YACZ,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,IAAA,+CAAqB,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/webserver/controllers/PreviewController.spec.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_1 = require("../../test");
+const preview_route_tests_1 = require("./test/preview-route-tests");
+describe('PreviewController', () => {
+    let server;
+    beforeAll(() => {
+        server = new test_1.TestServer();
+        server.start();
+    });
+    afterAll(() => {
+        server.stop();
+    });
+    (0, preview_route_tests_1.previewRouteTests)(() => server.request, 'http://localhost:3000');
+    it('renders the component mainFunction with inline preview information', async () => {
+        const output = await server.request.get('/r/unit-test-components/test-preview-component/1.2.4?_previewKey=test-preview');
+        expect(output.statusCode).toEqual(200);
+        expect(output.text).toMatchInlineSnapshot(`"800 | this is nested content"`);
+    });
+    it('renders the component function not main with no preview info', async () => {
+        const output = await server.request.get('/r/unit-test-components/test-preview-component/1.2.4/other?_previewKey=test-preview');
+        expect(output.text).toMatchInlineSnapshot(`"<code>{}</code>"`);
+        expect(output.statusCode).toEqual(200);
+    });
+    it('renders a component function with a data file for input', async () => {
+        const output = await server.request.get('/r/unit-test-components/test-preview-component/1.2.4?_previewKey=another-preview');
+        expect(output.statusCode).toEqual(200);
+        expect(output.text).toMatchInlineSnapshot(`"12300 | this is also nested content"`);
+    });
+    it('renders a component function with a wrapper file', async () => {
+        const output = await server.request.get('/r/unit-test-components/test-preview-component/1.2.4/other?_previewKey=another-preview');
+        expect(output.statusCode).toEqual(200);
+        expect(output.text).toMatchInlineSnapshot(`
+      "<!DOCTYPE html>
+      <html lang="en">
+        <head>
+          <meta charset="UTF-8" />
+          <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+          <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+          <title>This is the preview</title>
+        </head>
+        <body>
+          <code>{"random":"test-random-input","something":{"nested":123}}</code>
+        </body>
+      </html>
+      "
+    `);
+    });
+    it('renders the preview with static files URLs resolved', async () => {
+        const output = await server.request.get('/r/unit-test-components/test-preview-component/1.0.1?_previewKey=test-preview');
+        const expectedCssFileUrl = '/s/unit-test-components/test-preview-component/1.0.1/css-file.css?_previewKey=test-preview';
+        expect(output.statusCode).toEqual(200);
+        expect(output.text).toMatchInlineSnapshot(`
+      "<html>
+        <head>
+          <link rel="stylesheet" href="http://localhost:3000/s/unit-test-components/test-preview-component/1.0.1/css-file.css?_previewKey=test-preview">
+        </head>
+        <body>
+          <h1>hello</h1><p class="main">This has coloured background via CSS</p><p>Static URL - http://localhost:3000/s/unit-test-components/test-preview-component/1.0.1/js-file.js?_previewKey=test-preview</p> <script src="http://localhost:3000/s/unit-test-components/test-preview-component/1.0.1/js-file.js?_previewKey=test-preview"></script>
+        </body>
+      </html>
+      "
+    `);
+        const cssFile = await server.request.get(expectedCssFileUrl);
+        expect(cssFile.statusCode).toEqual(200);
+        expect(cssFile.text).toMatchInlineSnapshot(`
+      ".main,
+      p {
+        display: block;
+        background-color: rebeccapurple;
+      }
+      "
+    `);
+    });
+    it('the set response headers in the output', async () => {
+        const output = await server.request.get('/r/unit-test-components/test-preview-component/1.0.2?_previewKey=test-preview');
+        expect(output.statusCode).toEqual(200);
+        expect(output.header['some-header-1']).toEqual('val-1');
+        expect(output.header['some-header-2']).toEqual('val-2');
+    });
+    it("should throw a reasonable message when preview doesn't exist", async () => {
+        const response = await server.request.get('/r/unit-test-components/test-preview-component/1.2.4/?_previewKey=doest-exist');
+        expect(response.statusCode).toEqual(404);
+        expect(response.text).toMatchInlineSnapshot(`"{"message":"Component has not defined preview with key \\"doest-exist\\", the defined preview keys for this component are \\"test-preview, another-preview\\""}"`);
+    });
+    it('should allow previews to be embedded into cross origin webpages', async () => {
+        const response = await server.request.get('/r/unit-test-components/test-preview-component/1.0.4/?_previewKey=test-preview');
+        expect(response.header['content-security-policy']).toContain("frame-ancestors * 'self'");
+        expect(response.headers).not.toHaveProperty('X-Frame-Options');
+        expect(response.statusCode).toEqual(200);
+    });
+    it('passes through json file data to component', async () => {
+        const response = await server.request.get('/r/unit-test-components/test-preview-component/1.2.4/main?_previewKey=another-preview');
+        expect(response.text).toMatchInlineSnapshot(`"12300 | this is also nested content"`);
+        expect(response.statusCode).toEqual(200);
+    });
+    it('passes through js file data to component if it meets the input schema', async () => {
+        const response = await server.request.get('/r/unit-test-components/test-preview-component/1.0.6/main?_previewKey=preview-js-data-good-data');
+        expect(response.text).toMatchInlineSnapshot(`"works |  http://localhost:3000/s/unit-test-components/test-preview-component/1.0.6/sub/dir/static-library-file.js?_previewKey=preview-js-data-good-data | http://localhost:3000/r/unit-test-components/test-preview-component/1.0.6/some-function-name?_previewKey=preview-js-data-good-data&input=1234"`);
+        expect(response.statusCode).toEqual(200);
+    }, 6000000);
+    it('should pass down the preview key into info.ctx.getFunctionUrl and info.ctx.getStaticResourceUrl', async () => {
+        const response = await server.request.get('/r/unit-test-components/test-preview-component/1.0.5/?_previewKey=test-preview');
+        expect(response.statusCode).toEqual(200);
+        expect(response.text).toEqual('this is a result | 123 | http://localhost:3000/s/unit-test-components/test-preview-component/1.0.5/sub/dir/static-library-file.js?_previewKey=test-preview | http://localhost:3000/r/unit-test-components/test-preview-component/1.0.5/some-function-name?_previewKey=test-preview&input=1234');
+    });
+    // TODO unskip these in DEVX-808
+    it.skip("should throw and error if preview doesn't define the correct env vars", async () => {
+        const response = await server.request.get('/r/unit-test-components/test-environment-variables/1.0.3?_previewKey=missing-env-vars&something=123');
+        expect(response.statusCode).toEqual(400);
+        expect(response.text).toMatchInlineSnapshot(`"{\\"message\\":\\"Missing environment variables: \\\\\\"TEST_VARIABLE\\\\\\"\\"}"`);
+    });
+    it.skip('should render if the preview defines the correct env vars', async () => {
+        const response = await server.request.get('/r/unit-test-components/test-environment-variables/1.0.3?_previewKey=correct-env-vars&something=123');
+        expect(response.text).toMatchInlineSnapshot(`<div>component set {TEST_VARIABLE: "some-value"}`);
+        expect(response.statusCode).toEqual(200);
+    });
+    it.skip('should render when there are extra env vars, but the component should only receive the ones it requests', async () => {
+        const response = await server.request.get('/r/unit-test-components/test-environment-variables/1.0.3?_previewKey=correct-env-vars-with-extra&something=123');
+        expect(response.statusCode).toEqual(400);
+        expect(response.text).toMatchInlineSnapshot(`<div>component set {TEST_VARIABLE: "some-value"}`);
+    });
+});
+//# sourceMappingURL=PreviewController.spec.js.map

package/lib/webserver/controllers/PreviewController.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreviewController.spec.js","sourceRoot":"","sources":["../../../src/webserver/controllers/PreviewController.spec.ts"],"names":[],"mappings":";;AAAA,qCAAwC;AACxC,oEAA+D;AAE/D,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,IAAI,MAAkB,CAAC;IACvB,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,GAAG,IAAI,iBAAU,EAAE,CAAC;QAC1B,MAAM,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,GAAG,EAAE;QACZ,MAAM,CAAC,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,IAAA,uCAAiB,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;IAEjE,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACrC,+EAA+E,CAChF,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,gCAAgC,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACrC,qFAAqF,CACtF,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;QAC/D,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACrC,kFAAkF,CACnF,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,uCAAuC,CAAC,CAAC;IACrF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACrC,wFAAwF,CACzF,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;KAczC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACrC,+EAA+E,CAChF,CAAC;QAEF,MAAM,kBAAkB,GACtB,4FAA4F,CAAC;QAE/F,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;KAUzC,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAE7D,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC;;;;;;;KAO1C,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACrC,+EAA+E,CAChF,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACvC,+EAA+E,CAChF,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,qBAAqB,CACzC,mKAAmK,CACpK,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACvC,gFAAgF,CACjF,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QACzF,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;QAC/D,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACvC,uFAAuF,CACxF,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,uCAAuC,CAAC,CAAC;QACrF,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACvC,iGAAiG,CAClG,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,qBAAqB,CACzC,2SAA2S,CAC5S,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC,EAAE,OAAS,CAAC,CAAC;IAEd,EAAE,CAAC,iGAAiG,EAAE,KAAK,IAAI,EAAE;QAC/G,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACvC,gFAAgF,CACjF,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAC3B,+RAA+R,CAChS,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,gCAAgC;IAChC,EAAE,CAAC,IAAI,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;QAC1F,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACvC,qGAAqG,CACtG,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,qBAAqB,CACzC,oFAAoF,CACrF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACvC,qGAAqG,CACtG,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,kDAAkD,CAAC,CAAC;QAChG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC,yGAAyG,EAAE,KAAK,IAAI,EAAE;QAC5H,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,GAAG,CACvC,gHAAgH,CACjH,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,kDAAkD,CAAC,CAAC;IAClG,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/webserver/controllers/RenderController.d.ts

@@ -14,8 +14,9 @@ export declare class RenderController extends Controller {
     protected contentItemService: ContentItemService | null;
     protected componentPreviewService: ComponentPreviewService;
     constructor(componentSetService: ComponentSetService, manifestService: ManifestService, componentFunctionService: ComponentFunctionService, componentRunnerService: ComponentRunnerService, renderInputService: RenderInputService, contentItemService: ContentItemService | null, componentPreviewService: ComponentPreviewService);
-    getDefaultFunctionRendering(expressRequest: ExpressRequest, namespace: string, componentName: string, version: string, componentSet?: string, previewKey?: string, contentItemId?: string): Promise<void>;
-    getGivenFunctionRendering(expressRequest: ExpressRequest, namespace: string, componentName: string, version: string, functionName: string, componentSet?: string, previewKey?: string, contentItemId?: string): Promise<void>;
+    getDefaultFunctionRendering(expressRequest: ExpressRequest, namespace: string, componentName: string, version: string, componentSet?: string, previewKey?: string, contentItemId?: string, previewBlockIndex?: string): Promise<void>;
+    getGivenFunctionRendering(expressRequest: ExpressRequest, namespace: string, componentName: string, version: string, functionName: string, componentSet?: string, previewKey?: string, contentItemId?: string, previewBlockIndex?: string): Promise<void>;
+    protected processPreviewHtml(index: string, html: string): string;
     protected handleResponse(input: ComponentExecutionInput, output: FunctionReturnTypes, response: ExpressResponse): void;
     protected doFunctionRender(renderInput: ComponentExecutionInput): Promise<FunctionReturnTypes>;
     private renderAndValidateOutput;