feature: add poc for preview template support

kickstartDS · Oct 25, 2024 · 610de66 · 610de66
1 parent fe652d5
commit 610de66
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 0 deletions.
diff --git a/common/changes/@kickstartds/jsonschema-utils/main_2024-10-25-07-11.json b/common/changes/@kickstartds/jsonschema-utils/main_2024-10-25-07-11.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@kickstartds/jsonschema-utils",
+      "comment": "add preview cms annotation",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@kickstartds/jsonschema-utils"
+}
diff --git a/common/changes/@kickstartds/jsonschema2storyblok/main_2024-10-25-07-11.json b/common/changes/@kickstartds/jsonschema2storyblok/main_2024-10-25-07-11.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@kickstartds/jsonschema2storyblok",
+      "comment": "add poc for preview annotation support",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@kickstartds/jsonschema2storyblok"
+}
diff --git a/tools/jsonschema-utils/src/helpers.ts b/tools/jsonschema-utils/src/helpers.ts
@@ -84,6 +84,11 @@ export function getSchemaRegistry({ support2019 = false }: { support2019?: boole
     schemaType: 'boolean',
     validate: () => true
   });
+  ajv.addKeyword({
+    keyword: 'x-cms-preview',
+    schemaType: 'string',
+    validate: () => true
+  });
 
   return ajv;
 }

diff --git a/tools/jsonschema2storyblok/src/index.ts b/tools/jsonschema2storyblok/src/index.ts
@@ -197,6 +197,18 @@ function componentsEqual(componentOne: IStoryblokBlock, componentTwo: IStoryblok
   return componentOne.name === componentTwo.name;
 }
 
+function isCmsAnnotatedSchema(schema: unknown): schema is JSONSchema.Interface & {
+  'x-cms-hidden'?: boolean;
+  'x-cms-preview'?: string;
+} {
+  return (
+    typeof schema === 'object' &&
+    schema !== null &&
+    (('x-cms-hidden' in schema && schema['x-cms-hidden'] === true) ||
+      ('x-cms-preview' in schema && schema['x-cms-preview'] !== undefined))
+  );
+}
+
 function createBlokSchema(fields: IStoryblokSchemaElement[]): Record<string, IStoryblokSchemaElement> {
   return fields.reduce<Record<string, IStoryblokSchemaElement>>((schema, field) => {
     schema[field.key] = field;
@@ -252,6 +264,13 @@ function processObject({
       icon: icons[blokName] || 'block-wallet'
     };
 
+    if (isCmsAnnotatedSchema(subSchema) && subSchema['x-cms-preview']) {
+      if (subSchema['x-cms-preview'].startsWith('field:')) {
+        blok.preview_field = subSchema['x-cms-preview'].split(':')[1];
+      } else if (subSchema['x-cms-preview'].startsWith('template:')) {
+        blok.preview_tmpl = subSchema['x-cms-preview'].split(':')[1];
+      }
+    }
     if (description) field.description = description;
 
     return { field, components: [blok] };
@@ -334,6 +353,13 @@ function processObject({
       })
     };
   } else if (classification && classification === 'component') {
+    if (isCmsAnnotatedSchema(subSchema) && subSchema['x-cms-preview']) {
+      if (subSchema['x-cms-preview'].startsWith('field:')) {
+        bloks[0].preview_field = subSchema['x-cms-preview'].split(':')[1];
+      } else if (subSchema['x-cms-preview'].startsWith('template:')) {
+        bloks[0].preview_tmpl = subSchema['x-cms-preview'].split(':')[1];
+      }
+    }
     return { field: dummy, components: bloks };
   }
   throw new Error(
@@ -386,6 +412,14 @@ function processRef({
     blok.component_group_name = 'Components';
   }
 
+  if (isCmsAnnotatedSchema(subSchema) && subSchema['x-cms-preview']) {
+    if (subSchema['x-cms-preview'].startsWith('field:')) {
+      blok.preview_field = subSchema['x-cms-preview'].split(':')[1];
+    } else if (subSchema['x-cms-preview'].startsWith('template:')) {
+      blok.preview_tmpl = subSchema['x-cms-preview'].split(':')[1];
+    }
+  }
+
   if (description) field.description = description;
 
   return { field, components: [blok] };