@adobe/helix-config 2.0.0 → 2.2.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.2.0](https://github.com/adobe/helix-config/compare/v2.1.0...v2.2.0) (2024-03-28)
+
+
+### Features
+
+* add cnd.prod.route ([04ef870](https://github.com/adobe/helix-config/commit/04ef870efc8f9473d755c08573ccb2006010149a))
+
+# [2.1.0](https://github.com/adobe/helix-config/compare/v2.0.0...v2.1.0) (2024-03-27)
+
+
+### Features
+
+* return 404 for missing branch ([#33](https://github.com/adobe/helix-config/issues/33)) ([b3ea0f4](https://github.com/adobe/helix-config/commit/b3ea0f419f34ee0a94b02b9a67c06c64eec06d2d))
+
 # [2.0.0](https://github.com/adobe/helix-config/compare/v1.3.3...v2.0.0) (2024-03-14)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -36,7 +36,7 @@
     "@adobe/eslint-config-helix": "2.0.6",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/npm": "11.0.3",
+    "@semantic-release/npm": "12.0.0",
     "c8": "9.1.0",
     "eslint": "8.57.0",
     "husky": "9.0.11",

package/src/config-view.js

@@ -125,7 +125,7 @@ async function loadHeadHtml(ctx, config, ref) {
 }
 
 function retainProperty(obj, prop) {
-  if (!obj) {
+  if (!obj || Array.isArray(obj)) {
     return;
   }
   for (const key of Object.keys(obj)) {
@@ -181,10 +181,14 @@ export async function getConfigResponse(ctx, opts) {
   } = opts;
   const rso = { ref, site, org };
   const config = await resolveConfig(ctx, rso, scope);
+  const surrogateHeaders = {
+    'x-surrogate-key': await getSurrogateKey(opts),
+  };
   if (!config) {
     return new PipelineResponse('', {
       status: 404,
       headers: {
+        ...surrogateHeaders,
         'x-error': 'config not found.',
       },
     });
@@ -203,15 +207,10 @@ export async function getConfigResponse(ctx, opts) {
     }
   }
 
-  const headers = {
-    'content-type': 'application/json',
-    'x-surrogate-key': await getSurrogateKey(opts),
-  };
-
   if (opts.scope === SCOPE_DELIVERY) {
     return new PipelineResponse('', {
       headers: {
-        'x-surrogate-key': await getSurrogateKey(opts),
+        ...surrogateHeaders,
         'x-hlx-contentbus-id': config.content.contentBusId,
         'x-hlx-owner': config.code.owner,
         'x-hlx-repo': config.code.repo,
@@ -237,11 +236,25 @@ export async function getConfigResponse(ctx, opts) {
       },
     };
     return new PipelineResponse(JSON.stringify(adminConfig, null, 2), {
-      headers,
+      headers: {
+        'content-type': 'application/json',
+        ...surrogateHeaders,
+      },
     });
   }
 
   if (opts.scope === SCOPE_PIPELINE) {
+    // validate that ref exists in code-bus
+    if (!config.head?.html) {
+      return new PipelineResponse('', {
+        status: 404,
+        headers: {
+          'x-error': 'ref does not exit (no head.html)',
+          ...surrogateHeaders,
+        },
+      });
+    }
+
     // remove all properties except `host`. pipeline doesn't need the others.
     retainProperty(config.cdn, 'host');
     const pipelineConfig = {
@@ -258,7 +271,10 @@ export async function getConfigResponse(ctx, opts) {
       folders: config.folders,
     };
     return new PipelineResponse(JSON.stringify(pipelineConfig, null, 2), {
-      headers,
+      headers: {
+        'content-type': 'application/json',
+        ...surrogateHeaders,
+      },
     });
   }
 
@@ -269,6 +285,9 @@ export async function getConfigResponse(ctx, opts) {
     public: {},
   };
   return new PipelineResponse(JSON.stringify(publicConfig, null, 2), {
-    headers,
+    headers: {
+      'content-type': 'application/json',
+      ...surrogateHeaders,
+    },
   });
 }

package/src/schemas/cdn-config.schema.json

@@ -44,6 +44,13 @@
             "description": "production host",
             "type": "string"
           },
+          "route": {
+            "description": "Routes on the CDN that are rendered with Franklin",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "serviceId": {
             "description": "The Fastly Service ID",
             "type": "string"
@@ -53,7 +60,7 @@
             "type": "string"
           }
         },
-        "required": ["type", "host", "route", "serviceId", "authToken"],
+        "required": ["type", "host", "serviceId", "authToken"],
         "additionalProperties": false
       }, {
         "type": "object",
@@ -67,6 +74,13 @@
             "description": "production host",
             "type": "string"
           },
+          "route": {
+            "description": "Routes on the CDN that are rendered with Franklin",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "endpoint": {
             "type": "string"
           },
@@ -80,7 +94,7 @@
             "type": "string"
           }
         },
-        "required": ["type", "host", "route", "endpoint", "clientSecret", "clientToken", "accessToken"],
+        "required": ["type", "host", "endpoint", "clientSecret", "clientToken", "accessToken"],
         "additionalProperties": false
       }, {
         "type": "object",
@@ -94,6 +108,13 @@
             "description": "production host",
             "type": "string"
           },
+          "route": {
+            "description": "Routes on the CDN that are rendered with Franklin",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "origin": {
             "type": "string"
           },
@@ -107,7 +128,7 @@
             "type": "string"
           }
         },
-        "required": ["type", "host", "route", "origin", "plan", "zoneId", "apiToken"],
+        "required": ["type", "host", "origin", "plan", "zoneId", "apiToken"],
         "additionalProperties": false
       }, {
         "type": "object",
@@ -120,9 +141,16 @@
           "host": {
             "description": "production host",
             "type": "string"
+          },
+          "route": {
+            "description": "Routes on the CDN that are rendered with Franklin",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
           }
         },
-        "required": [ "type", "host", "route"],
+        "required": [ "type", "host"],
         "additionalProperties": false
       }]
     },

package/types/site-config.d.ts

@@ -139,6 +139,10 @@ export interface FastlyConfig {
    * production host
    */
   host: string;
+  /**
+   * Routes on the CDN that are rendered with Franklin
+   */
+  route?: string[];
   /**
    * The Fastly Service ID
    */
@@ -154,6 +158,10 @@ export interface AkamaiConfig {
    * production host
    */
   host: string;
+  /**
+   * Routes on the CDN that are rendered with Franklin
+   */
+  route?: string[];
   endpoint: string;
   clientSecret: string;
   clientToken: string;
@@ -165,6 +173,10 @@ export interface CloudflareConfig {
    * production host
    */
   host: string;
+  /**
+   * Routes on the CDN that are rendered with Franklin
+   */
+  route?: string[];
   origin: string;
   plan: string;
   zoneId: string;
@@ -176,6 +188,10 @@ export interface ManagedConfig {
    * production host
    */
   host: string;
+  /**
+   * Routes on the CDN that are rendered with Franklin
+   */
+  route?: string[];
 }
 export interface AdminAccessConfig {
   role?: Role;