prismic-ts-codegen 0.0.3 → 0.0.6

package/README.md

@@ -84,6 +84,10 @@ const config: Config = {
 
 	output: "./types.generated.ts",
 
+	clientIntegration: {
+		includeCreateClientInterface: true,
+	},
+
 	locales: {
 		ids: ["en-us", "fr-fr", "en-gb"],
 		fetchFromRepository: true,

package/bin/cli.mjs

@@ -4,7 +4,7 @@ import { readFileSync, existsSync, writeFileSync } from 'fs';
 import { resolve } from 'path';
 import meow from 'meow';
 import { stripIndent } from 'common-tags';
-import { Project } from 'ts-morph';
+import { Project, ModuleDeclarationKind } from 'ts-morph';
 import { CustomTypeModelFieldType, CustomTypeModelLinkSelectType, CustomTypeModelSliceType } from '@prismicio/types';
 import { pascalCase as pascalCase$1, pascalCaseTransformMerge } from 'pascal-case';
 import Joi from 'joi';
@@ -154,6 +154,9 @@ const writeFieldDocsDescription = (config) => {
   if (config.apiIDPath) {
     config.writer.writeLine(`- **API ID Path**: ${config.apiIDPath}`);
   }
+  if (config.tabName) {
+    config.writer.writeLine(`- **Tab**: ${config.tabName}`);
+  }
   if (config.documentationURL) {
     config.writer.writeLine(`- **Documentation**: ${config.documentationURL}`);
   }
@@ -185,6 +188,7 @@ const buildFieldDocs = (config) => {
           placeholder,
           defaultValue,
           apiIDPath,
+          tabName: config.tabName,
           documentationURL: getFieldDocumentationURL({ model: config.model })
         });
       }
@@ -200,7 +204,7 @@ const buildSharedSliceInterfaceName = (config) => {
   return pascalCase(`${config.id} Slice`);
 };
 
-const addInterfacePropertyFromField = (config) => {
+const addInterfacePropertyForField = (config) => {
   switch (config.model.type) {
     case "UID": {
       break;
@@ -212,7 +216,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -224,7 +229,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -236,7 +242,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -255,7 +262,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -267,7 +275,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -281,7 +290,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -291,7 +301,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -305,7 +316,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -319,7 +331,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
           break;
@@ -331,7 +344,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
           break;
@@ -343,7 +357,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
         }
@@ -357,7 +372,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -371,7 +387,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -381,7 +398,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -397,7 +415,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -407,7 +426,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -420,7 +440,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -432,7 +453,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -477,7 +499,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -626,7 +649,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -638,7 +662,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
     }
@@ -646,10 +671,11 @@ const addInterfacePropertyFromField = (config) => {
 };
 const addInterfacePropertiesForFields = (config) => {
   for (const name in config.fields) {
-    addInterfacePropertyFromField({
+    addInterfacePropertyForField({
       ...config,
       id: name.includes("-") ? `"${name}"` : name,
-      model: config.fields[name]
+      model: config.fields[name],
+      tabName: config.tabName
     });
   }
 };
@@ -676,18 +702,22 @@ const addTypeAliasForCustomType = ({
         }
       ]
     });
-    addInterfacePropertiesForFields({
-      fields,
-      interface: dataInterface,
-      sourceFile,
-      path: [
-        {
-          id: model.id,
-          model
-        }
-      ],
-      fieldConfigs
-    });
+    for (const tabName in model.json) {
+      const { uid: _uidField, ...tabFields } = model.json[tabName];
+      addInterfacePropertiesForFields({
+        fields: tabFields,
+        interface: dataInterface,
+        sourceFile,
+        path: [
+          {
+            id: model.id,
+            model
+          }
+        ],
+        fieldConfigs,
+        tabName
+      });
+    }
   } else {
     dataInterface = sourceFile.addTypeAlias({
       name: pascalCase(`${model.id} Document Data`),
@@ -910,6 +940,13 @@ const generateTypes = (config = {}) => {
         fieldConfigs: config.fieldConfigs || {}
       });
     }
+    if (config.customTypeModels.length > 0) {
+      sourceFile.addTypeAlias({
+        name: "AllDocumentTypes",
+        type: config.customTypeModels.map((customTypeModel) => pascalCase(`${customTypeModel.id} Document`)).join(" | "),
+        isExported: true
+      });
+    }
   }
   if (config.sharedSliceModels) {
     for (const model of config.sharedSliceModels) {
@@ -920,20 +957,60 @@ const generateTypes = (config = {}) => {
       });
     }
   }
+  if (config.clientIntegration?.includeCreateClientInterface) {
+    sourceFile.addImportDeclaration({
+      moduleSpecifier: "@prismicio/client",
+      namespaceImport: "prismic",
+      isTypeOnly: true
+    });
+    const clientModuleDeclaration = sourceFile.addModule({
+      name: '"@prismicio/client"',
+      hasDeclareKeyword: true,
+      declarationKind: ModuleDeclarationKind.Module
+    });
+    clientModuleDeclaration.addInterface({
+      name: "CreateClient",
+      callSignatures: [
+        {
+          parameters: [
+            {
+              name: "repositoryNameOrEndpoint",
+              type: "string"
+            },
+            {
+              name: "options",
+              type: "prismic.ClientConfig",
+              hasQuestionToken: true
+            }
+          ],
+          returnType: (config.customTypeModels?.length || 0) > 0 ? "prismic.Client<AllDocumentTypes>" : "prismic.Client"
+        }
+      ]
+    });
+  }
   return getSourceFileText(sourceFile);
 };
 
 const configSchema = Joi.object({
-  repositoryName: Joi.string(),
+  repositoryName: Joi.string().when("locales.fetchFromRepository", {
+    is: true,
+    then: Joi.required()
+  }).when("models.fetchFromRepository", {
+    is: true,
+    then: Joi.required()
+  }),
   accessToken: Joi.string(),
   customTypesAPIToken: Joi.string(),
   output: Joi.string(),
+  clientIntegration: {
+    includeCreateClientInterface: Joi.boolean
+  },
   locales: Joi.alternatives(Joi.array().items(Joi.string().required()), Joi.object({
     ids: Joi.array().items(Joi.string().required()),
     fetchFromRepository: Joi.boolean()
   })),
-  models: Joi.alternatives(Joi.array().items(Joi.string().required()), Joi.object({
-    files: Joi.array().items(Joi.string().required()),
+  models: Joi.alternatives(Joi.array().items(Joi.string()), Joi.object({
+    files: Joi.array().items(Joi.string()),
     fetchFromRepository: Joi.boolean()
   })),
   fields: Joi.object({
@@ -944,23 +1021,6 @@ const configSchema = Joi.object({
       catalogTypes: Joi.object().pattern(Joi.string(), Joi.string().required())
     })
   })
-}).when(Joi.object({
-  locales: Joi.object({
-    fetchFromRepository: Joi.valid(true)
-  })
-}), {
-  then: Joi.object({
-    repositoryName: Joi.required()
-  })
-}).when(Joi.object({
-  models: Joi.object({
-    fetchFromRepository: Joi.valid(true)
-  })
-}), {
-  then: Joi.object({
-    repositoryName: Joi.required(),
-    customTypesAPIToken: Joi.required()
-  })
 });
 
 const loadLocaleIDs = async (config) => {
@@ -1090,7 +1150,6 @@ ${configPath} already exists.`);
 
 					const config: Config = {
 					  output: "./types.generated.ts",
-
 					  models: ["./customtypes/**/index.json", "./slices/**/model.json"],
 					};
 
@@ -1127,13 +1186,23 @@ Created prismic-ts-codegen config file: ${configPath}`);
         accessToken: config.accessToken,
         fetchFromRepository: config.locales && "fetchFromRepository" in config.locales && config.locales.fetchFromRepository
       });
+      const hasCustomTypeModels = customTypeModels.length > 0;
       const types = generateTypes({
         customTypeModels,
         sharedSliceModels,
-        localeIDs
+        localeIDs,
+        fieldConfigs: config.fields,
+        clientIntegration: {
+          includeCreateClientInterface: hasCustomTypeModels ? config.clientIntegration?.includeCreateClientInterface ?? true : false
+        }
       });
+      if (config.clientIntegration?.includeCreateClientInterface && !hasCustomTypeModels) {
+        console.info("[INFO]: prismic-ts-codegen was configured to automatically integrate with `@prismicio/client`, but the integration was generated because no Custom Type models were found. Automatic integration requires at least one Custom Type model.");
+      }
       if (config.output) {
         writeFileSync(resolve(config.output), types);
+        console.info(`
+Generated types in: ${config.output}`);
       } else {
         process.stdout.write(types + "\n");
       }