@squiz/render-runtime-lib 1.70.1 → 1.72.0

package/lib/migrations/202408061132_update_type_to_server.sql

@@ -0,0 +1 @@
+UPDATE "component" SET "type" = 'server' WHERE "type" = 'sandbox';

package/lib/public/docs.json

@@ -5007,6 +5007,30 @@
 				"type": "object",
 				"additionalProperties": {}
 			},
+			"Pick_MANIFEST_MODELS.v1.ComponentManifest.type_": {
+				"properties": {
+					"type": {
+						"type": "string",
+						"enum": [
+							"edge",
+							"server"
+						],
+						"description": "Type of component that will be deployed to different runtimes"
+					}
+				},
+				"type": "object",
+				"description": "From T, pick a set of properties whose keys are in the union K"
+			},
+			"ComponentFunctionDefinitionResponse": {
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/MANIFEST_MODELS.v1.ComponentFunction"
+					},
+					{
+						"$ref": "#/components/schemas/Pick_MANIFEST_MODELS.v1.ComponentManifest.type_"
+					}
+				]
+			},
 			"ComponentManifest": {
 				"$ref": "#/components/schemas/MANIFEST_MODELS.v1.ComponentManifest"
 			},
@@ -5031,7 +5055,7 @@
 	},
 	"info": {
 		"title": "@squiz/render-runtime-lib",
-		"version": "1.70.0",
+		"version": "1.71.0",
 		"description": "Package of rendering utilities for components",
 		"license": {
 			"name": "ISC"
@@ -5166,7 +5190,7 @@
 						"content": {
 							"application/json": {
 								"schema": {
-									"$ref": "#/components/schemas/MANIFEST_MODELS.v1.ComponentFunction"
+									"$ref": "#/components/schemas/ComponentFunctionDefinitionResponse"
 								}
 							}
 						}
@@ -5226,7 +5250,7 @@
 						"content": {
 							"application/json": {
 								"schema": {
-									"$ref": "#/components/schemas/MANIFEST_MODELS.v1.ComponentFunction"
+									"$ref": "#/components/schemas/ComponentFunctionDefinitionResponse"
 								}
 							}
 						}

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

@@ -1,7 +1,6 @@
 import { Controller } from 'tsoa';
 import { type Request as ExpressRequest, type Response as ExpressResponse } from 'express';
-import { ManifestModel, ManifestService, ComponentFunctionService, ComponentSetService, Manifest, Headers } from '@squiz/component-lib';
-import { MANIFEST_MODELS } from '@squiz/dx-json-schema-lib';
+import { ManifestModel, ManifestService, ComponentFunctionService, ComponentSetService, Manifest, Headers, ComponentFunctionDefinitionResponse } from '@squiz/component-lib';
 import { ComponentRootUrlResolver } from '../../component-runner';
 export declare class DefinitionController extends Controller {
     protected componentSetService: ComponentSetService;
@@ -10,8 +9,8 @@ export declare class DefinitionController extends Controller {
     protected componentRootUrlResolver: ComponentRootUrlResolver;
     constructor(componentSetService: ComponentSetService, manifestService: ManifestService, componentFunctionService: ComponentFunctionService, componentRootUrlResolver: ComponentRootUrlResolver);
     getComponentVersionManifest(namespace: string, componentName: string, version: string, request: ExpressRequest, _previewKey?: string, _componentSet?: string): Promise<ManifestModel>;
-    getDefaultFunctionDefinition(namespace: string, componentName: string, version: string, request: ExpressRequest, _previewKey?: string, _componentSet?: string): Promise<MANIFEST_MODELS.v1.ComponentFunction>;
-    getGivenFunctionDefinition(namespace: string, componentName: string, version: string, functionName: string, request: ExpressRequest, _previewKey?: string, _componentSet?: string): Promise<MANIFEST_MODELS.v1.ComponentFunction>;
+    getDefaultFunctionDefinition(namespace: string, componentName: string, version: string, request: ExpressRequest, _previewKey?: string, _componentSet?: string): Promise<ComponentFunctionDefinitionResponse>;
+    getGivenFunctionDefinition(namespace: string, componentName: string, version: string, functionName: string, request: ExpressRequest, _previewKey?: string, _componentSet?: string): Promise<ComponentFunctionDefinitionResponse>;
     private setHeadersFromComponentSet;
     protected setHeadersFromPreview(manifest: Manifest, _previewKey: string, functionName: string, response: ExpressResponse): void;
     protected setHeaders(headers: Headers, response: ExpressResponse): void;