Merge pull request #54 from kickstartDS/fix/add-option-to-toggle-defa…

…ult-page

Add option to toggle default page

CHANGELOG.md

@@ -1,3 +1,18 @@
+# v3.1.0 (Tue Aug 20 2024)
+
+#### 🚀 Enhancement
+
+- Add cms layering capabilities [#52](https://github.com/kickstartDS/cli/pull/52) ([@julrich](https://github.com/julrich))
+
+#### 🐛 Bug Fix
+
+
+#### Authors: 1
+
+- Jonas Ulrich ([@julrich](https://github.com/julrich))
+
+---
+
 # v3.0.0 (Fri Apr 12 2024)
 
 #### 💥 Breaking Change

package.json

@@ -1,6 +1,6 @@
 {
   "name": "kickstartds",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "kickstartDS CLI utility",
   "keywords": [],
   "license": "(MIT OR Apache-2.0)",

src/commands/schema/dereference.ts

@@ -15,6 +15,10 @@ const dereference = new Command('dereference')
     '--cms-path <path>',
     chalkTemplate`relative path from project root to your cms specific components directory, default {bold ./src/components}`
   )
+  .option(
+    '--no-default-page-schema',
+    chalkTemplate`disable load of default page schema, default {bold false}`
+  )
   .option(
     '--rc-only',
     chalkTemplate`only read configuration from {bold .schema-dereferencerc.json}, skip prompts`,
@@ -31,6 +35,7 @@ const dereference = new Command('dereference')
     runTask(
       options.componentsPath,
       options.cmsPath,
+      options.defaultPageSchema,
       options.rcOnly,
       options.revert,
       options.cleanup,

src/commands/schema/layer.ts

@@ -25,6 +25,10 @@ const types = new Command('layer')
     chalkTemplate`merge allOf declarations in processed {bold JSON Schemas} / {bold component APIs}, default {bold false}`,
     false
   )
+  .option(
+    '--no-default-page-schema',
+    chalkTemplate`disable load of default page schema, default {bold false}`
+  )
   .option(
     '--rc-only',
     chalkTemplate`only read configuration from {bold .schema-typesrc.json}, skip prompts`,
@@ -43,6 +47,7 @@ const types = new Command('layer')
       options.cmsPath,
       options.typesPath,
       options.mergeSchemas,
+      options.defaultPageSchema,
       options.rcOnly,
       options.revert,
       options.cleanup,

src/commands/schema/types.ts

@@ -20,6 +20,10 @@ const types = new Command('types')
     chalkTemplate`merge allOf declarations in processed {bold JSON Schemas} / {bold component APIs}, default {bold false}`,
     false
   )
+  .option(
+    '--no-default-page-schema',
+    chalkTemplate`disable load of default page schema, default {bold false}`
+  )
   .option(
     '--rc-only',
     chalkTemplate`only read configuration from {bold .schema-typesrc.json}, skip prompts`,
@@ -37,6 +41,7 @@ const types = new Command('types')
       options.componentsPath,
       options.cmsPath,
       options.mergeSchemas,
+      options.defaultPageSchema,
       options.rcOnly,
       options.revert,
       options.cleanup,

src/tasks/schema/dereference-task.ts

@@ -31,6 +31,7 @@ const {
 const run = async (
   componentsPath: string = 'src/components',
   cmsPath: string,
+  defaultPageSchema: boolean = true,
   rcOnly: boolean,
   isRevert: boolean,
   shouldCleanup: boolean,
@@ -56,7 +57,7 @@ const run = async (
       globs.push(`${callingPath}/${cmsPath}/**/*.schema.json`);
     }
     const customSchemaPaths = await fg(globs);
-    const dereffed = await schemaDereferenceSchemas(globs);
+    const dereffed = await schemaDereferenceSchemas(globs, defaultPageSchema);
 
     logger.info(
       chalkTemplate`dereffed {bold ${

src/tasks/schema/layer-task.ts

@@ -35,6 +35,7 @@ const run = async (
   cmsPath: string,
   typesPath: string = 'src/types',
   mergeSchemas: boolean,
+  defaultPageSchema: boolean = true,
   rcOnly: boolean,
   isRevert: boolean,
   shouldCleanup: boolean,
@@ -62,7 +63,8 @@ const run = async (
 
     const layeredTypes = await schemaLayerComponentPropTypes(
       globs,
-      mergeSchemas
+      mergeSchemas,
+      defaultPageSchema
     );
 
     shell.mkdir('-p', `${shell.pwd()}/${typesPath}/`);

src/tasks/schema/types-task.ts

@@ -33,6 +33,7 @@ const run = async (
   componentsPath: string = 'src/components',
   cmsPath: string,
   mergeSchemas: boolean,
+  defaultPageSchema: boolean = true,
   rcOnly: boolean,
   isRevert: boolean,
   shouldCleanup: boolean,
@@ -58,7 +59,11 @@ const run = async (
       globs.push(`${callingPath}/${cmsPath}/**/*.schema.json`);
     }
     const customSchemaPaths = await fg(globs);
-    const types = await schemaGenerateComponentPropTypes(globs, mergeSchemas);
+    const types = await schemaGenerateComponentPropTypes(
+      globs,
+      mergeSchemas,
+      defaultPageSchema
+    );
 
     await Promise.all(
       Object.keys(types).map(async (schemaId) => {

src/util/schema.ts

@@ -26,9 +26,14 @@ const renderImportName = (schemaId: string) =>
 export default (logger: winston.Logger): SchemaUtil => {
   const subCmdLogger = logger.child({ utility: true });
 
-  const dereferenceSchemas = async (schemaGlobs: string[]) => {
+  const dereferenceSchemas = async (
+    schemaGlobs: string[],
+    defaultPageSchema = true
+  ) => {
     const ajv = getSchemaRegistry();
-    const schemaIds = await processSchemaGlobs(schemaGlobs, ajv);
+    const schemaIds = await processSchemaGlobs(schemaGlobs, ajv, {
+      loadPageSchema: defaultPageSchema,
+    });
     const customSchemaIds = getCustomSchemaIds(schemaIds);
 
     const dereffedSchemas = await dereference(customSchemaIds, ajv);
@@ -76,7 +81,8 @@ export default (logger: winston.Logger): SchemaUtil => {
 
   const generateComponentPropTypes = async (
     schemaGlobs: string[],
-    mergeAllOf: boolean
+    mergeAllOf: boolean,
+    defaultPageSchema = true
   ) => {
     subCmdLogger.info(
       chalkTemplate`generating component prop types for component schemas`
@@ -86,6 +92,7 @@ export default (logger: winston.Logger): SchemaUtil => {
     const schemaIds = await processSchemaGlobs(schemaGlobs, ajv, {
       typeResolution: false,
       mergeAllOf: mergeAllOf,
+      loadPageSchema: defaultPageSchema,
     });
     const customSchemaIds = getCustomSchemaIds(schemaIds);
 
@@ -116,7 +123,8 @@ export default (logger: winston.Logger): SchemaUtil => {
 
   const layerComponentPropTypes = async (
     schemaGlobs: string[],
-    mergeAllOf: boolean
+    mergeAllOf: boolean,
+    defaultPageSchema = true
   ) => {
     subCmdLogger.info(
       chalkTemplate`layering component prop types for component schemas`
@@ -126,6 +134,7 @@ export default (logger: winston.Logger): SchemaUtil => {
     const schemaIds = await processSchemaGlobs(schemaGlobs, ajv, {
       typeResolution: false,
       mergeAllOf: mergeAllOf,
+      loadPageSchema: defaultPageSchema,
     });
     const kdsSchemaIds = schemaIds.filter((schemaId) =>
       schemaId.includes('schema.kickstartds.com')

types/index.d.ts

@@ -215,14 +215,17 @@ interface SchemaUtil {
   helper: {
     generateComponentPropTypes: (
       schemaGlobs: string[],
-      mergeAllOf: boolean
+      mergeAllOf: boolean,
+      defaultPageSchema: boolean
     ) => Promise<Record<string, string>>;
     layerComponentPropTypes: (
       schemaGlobs: string[],
-      mergeAllOf: boolean
+      mergeAllOf: boolean,
+      defaultPageSchema: boolean
     ) => Promise<Record<string, string>>;
     dereferenceSchemas: (
-      schemaGlobs: string[]
+      schemaGlobs: string[],
+      defaultPageSchema: boolean
     ) => Promise<Record<string, JSONSchema.Interface>>;
     toStoryblok: (
       schemaGlobs: string[],