@squiz/render-runtime-lib 1.2.1-alpha.100

package/lib/migrations/20220704054051_initial.sql

@@ -0,0 +1,19 @@
+-- CreateTable
+
+CREATE TABLE "component" ("name" VARCHAR(128) NOT NULL,
+                                              CONSTRAINT "component_pkey" PRIMARY KEY ("name"));
+
+-- CreateTable
+
+CREATE TABLE "component_version" ("component_name" VARCHAR(128) NOT NULL,
+                                                                "version" VARCHAR(128) NOT NULL,
+                                                                                       CONSTRAINT "component_version_pkey" PRIMARY KEY ("component_name",
+                                                                                                                                        "version"));
+
+-- AddForeignKey
+
+ALTER TABLE "component_version" ADD CONSTRAINT "component_version_component_name_fkey"
+FOREIGN KEY ("component_name") REFERENCES "component"("name") ON
+DELETE CASCADE ON
+UPDATE CASCADE;
+

package/lib/migrations/20220718172237_adding_component_sets.sql

@@ -0,0 +1,23 @@
+-- CreateTable
+CREATE TABLE "component_set" (
+    "web_path" VARCHAR(128) NOT NULL,
+    "display_name" VARCHAR(128) NOT NULL,
+    "description" VARCHAR,
+    "env_vars" JSONB,
+    "headers" JSONB,
+
+    CONSTRAINT "component_set_pkey" PRIMARY KEY ("web_path")
+);
+
+-- CreateTable
+CREATE TABLE "component_set_component_version" (
+    "component_set_web_path" VARCHAR(128) NOT NULL,
+    "component_name" VARCHAR(128) NOT NULL,
+    "component_version" VARCHAR(128) NOT NULL,
+
+    CONSTRAINT "component_set_component_version_pkey" PRIMARY KEY ("component_set_web_path", "component_name", "component_version")
+);
+
+-- AddForeignKey
+ALTER TABLE "component_set_component_version" ADD CONSTRAINT "component_set_web_path_fkey" FOREIGN KEY ("component_set_web_path") REFERENCES "component_set"("web_path") ON DELETE CASCADE ON UPDATE CASCADE;
+ALTER TABLE "component_set_component_version" ADD CONSTRAINT "component_version_componet_name_version_fkey" FOREIGN KEY ("component_name", "component_version") REFERENCES "component_version"("component_name", "version") ON DELETE CASCADE ON UPDATE CASCADE;

package/lib/migrations/20220728113941_add_env_vars_field.sql

@@ -0,0 +1 @@
+ALTER TABLE "component_set_component_version" ADD COLUMN "env_vars" jsonb;

package/lib/migrations/20220817113300_removing_null_props_from_jsonb.sql

@@ -0,0 +1,41 @@
+UPDATE component_set as rc
+set env_vars = (
+
+  -- subtract non string properties, resulting object is all keys have values
+  select COALESCE((o2.env_vars - od.nonStringProps), '{}'::jsonb) as stringProps
+  from component_set as o2 , (
+
+    -- select get an array of all properties whos value is not a string, as an array
+    select web_path, array(
+      select envK
+      from component_set, jsonb_object_keys(env_vars) as envK
+      where  jsonb_typeof(component_set.env_vars->envk) <> 'string' and o.web_path = component_set.web_path
+    ) as nonStringProps
+    from component_set as o
+  ) as od
+
+  -- make sure all the web_paths are the same
+  where o2.web_path = od.web_path and rc.web_path = o2.web_path
+),
+headers = (
+  -- subtract non string properties resulting object is all keys have values
+  select COALESCE((o2.headers - od.nonStringProps), '{}'::jsonb) as stringProps
+  from component_set as o2 , (
+
+    -- select get an array of all properties whos value is not a string, as an array
+    select web_path, array(
+      select headerK
+      from component_set, jsonb_object_keys(headers) as headerK
+      where  jsonb_typeof(component_set.headers->headerK) <> 'string' and o.web_path = component_set.web_path
+    ) as nonStringProps
+    from component_set as o
+  ) as od
+
+  -- make sure all the web_paths are the same
+  where o2.web_path = od.web_path and rc.web_path = o2.web_path
+);
+
+-- make columns not nullable
+ALTER TABLE component_set ALTER COLUMN env_vars SET NOT NULL;
+ALTER TABLE component_set ALTER COLUMN headers SET NOT NULL;
+

package/lib/render-runtime-lib.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/helpers/fixtures.d.ts

@@ -0,0 +1,20 @@
+import { ExecuteComponentTask } from '@squiz/component-lib';
+declare type ComponentReturn = string | object;
+export declare class ComponentFixture {
+    static fixtureRootDirectory: string | undefined;
+    protected static getFixtureRootDirectory(): string;
+    static setupFullComponentDirectory(returnObj: ComponentReturn): Promise<{
+        fixtureDirectory: string;
+        version: string;
+        componentName: string;
+    }>;
+    static new(returnObj: string | object, { raw, environment }?: {
+        raw?: boolean | undefined;
+        environment?: string[] | undefined;
+    }): Promise<ExecuteComponentTask>;
+    static updateComponent(component: ExecuteComponentTask, output: string | object): Promise<ExecuteComponentTask>;
+    private static createFixtureDirectory;
+    private static createVersionDirectory;
+    private static createManifest;
+}
+export {};

package/lib/test/helpers/stack.d.ts

@@ -0,0 +1,6 @@
+import supertest from 'supertest';
+import { type RenderRuntimeConfig } from '../../';
+import { Logger } from '@squiz/dx-logger-lib';
+export declare const testLogger: Logger;
+export declare function getTestConfig(port: number): RenderRuntimeConfig;
+export declare function getTestServer(): supertest.SuperTest<supertest.Test>;

package/lib/test/index.d.ts

@@ -0,0 +1,2 @@
+export * from './helpers/fixtures';
+export * from './helpers/stack';

package/lib/utils/convertFunctionStaticFilesToFqdn.d.ts

@@ -0,0 +1 @@
+export declare function convertFunctionStaticFilesToFqdn(file: string, componentName: string, version: string): string;

package/lib/utils/convertFunctionStaticFilesToFqdn.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/utils/getFunctionDefinitionFromManifest.d.ts

@@ -0,0 +1,2 @@
+import { ComponentFunction, Manifest } from '@squiz/component-lib';
+export declare function getFunctionDefinitionFromManifest(functionName: string, manifest: Manifest): ComponentFunction | undefined;

package/lib/utils/getManifestPath.d.ts

@@ -0,0 +1 @@
+export declare function getManifestPath(componentName: string, version: string, isInProductionMode: boolean): Promise<string>;

package/lib/utils/getManifestPath.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/utils/getPreviewFilePath.d.ts

@@ -0,0 +1 @@
+export declare function getPreviewFilePath(manifestPath: string): string;

package/lib/utils/getPreviewFilePath.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/utils/isInProductionMode.d.ts

@@ -0,0 +1 @@
+export declare function isInProductionMode(): boolean;

package/lib/utils/isInProductionMode.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/utils/resolvePreviewOutput.d.ts

@@ -0,0 +1,2 @@
+import { HtmlStaticFile } from '@squiz/component-lib';
+export declare function resolvePreviewOutput(html: string, componentOutput: string, files: HtmlStaticFile[]): string;

package/lib/utils/resolvePreviewOutput.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/webserver/app.d.ts

@@ -0,0 +1,4 @@
+import { type Express } from 'express';
+import { Logger } from '@squiz/dx-logger-lib';
+import { ComponentConnectionManager } from '@squiz/component-db-lib';
+export declare function setupApp(logger: Logger, db?: ComponentConnectionManager): Express;

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

@@ -0,0 +1,3 @@
+import { type Router } from 'express';
+declare const router: Router;
+export default router;

package/lib/webserver/controllers/core.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,3 @@
+import { type Router } from 'express';
+declare const router: Router;
+export default router;

package/lib/webserver/controllers/definition.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,4 @@
+export { default as renderRoutes } from './render';
+export { default as definitionRoutes } from './definition';
+export { default as staticRoutes } from './static';
+export { default as coreRoutes } from './core';

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

@@ -0,0 +1,3 @@
+import { type Router } from 'express';
+declare const router: Router;
+export default router;

package/lib/webserver/controllers/render.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,3 @@
+import { type Router } from 'express';
+declare const router: Router;
+export default router;

package/lib/webserver/controllers/static.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/webserver/controllers/test/definition-route-tests.d.ts

@@ -0,0 +1 @@
+export declare function definitionRouteTests(rootUrl: string, accessingUrl: string): void;

package/lib/webserver/controllers/test/render-route-tests.d.ts

@@ -0,0 +1 @@
+export declare function renderRouteTests(rootUrl: string, accessingUrl: string): void;

package/lib/webserver/controllers/test/static-route-tests.d.ts

@@ -0,0 +1 @@
+export declare function staticRouteTests(url: string): void;

package/lib/webserver/index.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" />
+import { type Server } from 'http';
+import { Logger } from '@squiz/dx-logger-lib';
+import { ComponentConnectionManager } from '@squiz/component-db-lib';
+export interface WebserverConfig {
+    port?: number;
+    rootUrl: string;
+    shouldRunMigrations: boolean;
+    compiledConfig?: {
+        buildVersion?: string;
+        buildBranch?: string;
+    };
+}
+export declare class Webserver {
+    private static singleton;
+    private static config;
+    static get(): Server;
+    static getConfig(): WebserverConfig;
+    static start(config: Omit<WebserverConfig, 'compiledConfig'>, logger: Logger, db?: ComponentConnectionManager, compiledConfig?: Record<string, string>): Promise<Server>;
+    static stop(): void;
+    private static mergeConfig;
+}