prismic-ts-codegen 0.0.2 → 0.0.5

package/README.md

@@ -20,7 +20,7 @@ An experimental Prismic model-to-TypeScript-type generator.
 ## Install
 
 ```bash
-npm install --save-dev prismic-ts-codegen
+npm install --save-dev prismic-ts-codegen @prismicio/types
 ```
 
 ## Usage
@@ -62,7 +62,60 @@ npm install --save-dev prismic-ts-codegen
 
 ## Documentation
 
-To discover what's new on this package check out [the changelog][changelog]. For full documentation, visit the [official Prismic documentation][prismic-docs].
+### Configuration
+
+`prismic-ts-codegen` is configured using a `prismicCodegen.config.ts` file. It must export a configuration object as the default export.
+
+#### Interface
+
+See the [`Config` TypeScript interface](./src/cli/types.ts) for a complete reference of each configuration property.
+
+#### Full example
+
+```typescript
+// prismicCodegen.config.ts
+
+import type { Config } from "prismic-ts-codegen";
+
+const config: Config = {
+	repositoryName: "nextjs-blog-demo",
+	accessToken: "abc123xyz345",
+	customTypesAPIToken: "abc123xyz345",
+
+	output: "./types.generated.ts",
+
+	clientIntegration: {
+		includeCreateClientInterface: true,
+	},
+
+	locales: {
+		ids: ["en-us", "fr-fr", "en-gb"],
+		fetchFromRepository: true,
+	},
+
+	models: {
+		files: ["./customtypes/**/index.json", "./slices/**/model.json"],
+		fetchFromRepository: true,
+	},
+
+	fields: {
+		embed: {
+			providerTypes: {
+				YouTube: 'import("./types").OEmbedYouTube',
+				Twitter: 'import("./types").OEmbedTwitter',
+				Vimeo: 'import("./types").OEmbedVimeo',
+			},
+		},
+		integrationFields: {
+			catalogTypes: {
+				shop: 'import("./types").IntegrationFieldShop',
+			},
+		},
+	},
+};
+
+export default config;
+```
 
 ## Contributing
 

package/bin/cli.mjs

@@ -4,7 +4,8 @@ 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';
 import * as prismic from '@prismicio/client';
@@ -39,33 +40,6 @@ const FIELD_DOCUMENTATION_URLS = {
   Slices: "https://prismic.io/docs/core-concepts/slices"
 };
 
-const CustomTypeModelFieldType = {
-  Boolean: "Boolean",
-  Color: "Color",
-  Date: "Date",
-  Embed: "Embed",
-  GeoPoint: "GeoPoint",
-  Group: "Group",
-  Image: "Image",
-  IntegrationFields: "IntegrationFields",
-  Link: "Link",
-  Number: "Number",
-  Select: "Select",
-  Slices: "Slices",
-  StructuredText: "StructuredText",
-  Text: "Text",
-  Timestamp: "Timestamp",
-  UID: "UID"
-};
-const CustomTypeModelLinkSelectType = {
-  Document: "document",
-  Media: "media"
-};
-const CustomTypeModelSliceType = {
-  Slice: "Slice",
-  SharedSlice: "SharedSlice"
-};
-
 const isCustomTypeModelField = (model) => {
   return typeof model === "object" && model !== null && "type" in model && "config" in model;
 };
@@ -180,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}`);
   }
@@ -211,6 +188,7 @@ const buildFieldDocs = (config) => {
           placeholder,
           defaultValue,
           apiIDPath,
+          tabName: config.tabName,
           documentationURL: getFieldDocumentationURL({ model: config.model })
         });
       }
@@ -226,7 +204,7 @@ const buildSharedSliceInterfaceName = (config) => {
   return pascalCase(`${config.id} Slice`);
 };
 
-const addInterfacePropertyFromField = (config) => {
+const addInterfacePropertyForField = (config) => {
   switch (config.model.type) {
     case "UID": {
       break;
@@ -238,7 +216,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -250,7 +229,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -262,7 +242,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -281,7 +262,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -293,7 +275,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -307,7 +290,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -317,7 +301,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -331,7 +316,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -345,7 +331,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
           break;
@@ -357,7 +344,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
           break;
@@ -369,7 +357,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
         }
@@ -383,7 +372,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -397,7 +387,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -407,7 +398,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -423,7 +415,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -433,7 +426,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -446,7 +440,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -458,7 +453,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -481,7 +477,8 @@ const addInterfacePropertyFromField = (config) => {
               writer.writeLine(`Item in ${humanReadablePath}`);
             }
           }
-        ]
+        ],
+        isExported: true
       });
       addInterfacePropertiesForFields({
         interface: itemInterface,
@@ -502,7 +499,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -592,7 +590,8 @@ const addInterfacePropertyFromField = (config) => {
                     writer.writeLine(`Item in ${humanReadablePath}`);
                   }
                 }
-              ]
+              ],
+              isExported: true
             });
             addInterfacePropertiesForFields({
               interface: itemInterface,
@@ -618,7 +617,8 @@ const addInterfacePropertyFromField = (config) => {
           }
           const sliceType = config.sourceFile.addTypeAlias({
             name: pascalCase(`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice`),
-            type: `prismicT.Slice<"${choiceId}", ${primaryInterface ? `Simplify<${primaryInterface.getName()}>` : "Record<string, never>"}, ${itemInterface ? `Simplify<${itemInterface.getName()}>` : "never"}>`
+            type: `prismicT.Slice<"${choiceId}", ${primaryInterface ? `Simplify<${primaryInterface.getName()}>` : "Record<string, never>"}, ${itemInterface ? `Simplify<${itemInterface.getName()}>` : "never"}>`,
+            isExported: true
           });
           choiceInterfaceNames.push(sliceType.getName());
         }
@@ -649,7 +649,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -661,7 +662,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
     }
@@ -669,10 +671,11 @@ const addInterfacePropertyFromField = (config) => {
 };
 const addInterfacePropertiesForFields = (config) => {
   for (const name in config.fields) {
-    addInterfacePropertyFromField({
+    addInterfacePropertyForField({
       ...config,
-      id: name,
-      model: config.fields[name]
+      id: name.includes("-") ? `"${name}"` : name,
+      model: config.fields[name],
+      tabName: config.tabName
     });
   }
 };
@@ -699,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`),
@@ -819,7 +826,8 @@ const addTypeAliasForSharedSlice = (config) => {
               writer.writeLine(`Item in ${humanReadablePath}`);
             }
           }
-        ]
+        ],
+        isExported: true
       });
       addInterfacePropertiesForFields({
         interface: itemInterface,
@@ -853,7 +861,8 @@ const addTypeAliasForSharedSlice = (config) => {
             writer.writeLine(`- **Documentation**: ${SHARED_SLICES_DOCUMENTATION_URL}`);
           }
         }
-      ]
+      ],
+      isExported: true
     });
     variationTypeNames.push(variationType.getName());
   }
@@ -931,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) {
@@ -941,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({
@@ -965,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) => {
@@ -1023,7 +1062,7 @@ const loadModels = async (config) => {
     });
     if (config.fetchFromRepository) {
       const [remoteCustomTypeModels, remoteSharedSliceModels] = await Promise.all([
-        customTypesClient.getAll(),
+        customTypesClient.getAllCustomTypes(),
         customTypesClient.getAllSharedSlices()
       ]);
       for (const customTypeModel of remoteCustomTypeModels) {
@@ -1045,8 +1084,12 @@ const loadModels = async (config) => {
     }
   }
   return {
-    customTypeModels: Object.values(customTypeModels),
-    sharedSliceModels: Object.values(sharedSliceModels)
+    customTypeModels: Object.values(customTypeModels).sort((a, b) => {
+      return a.id.localeCompare(b.id);
+    }),
+    sharedSliceModels: Object.values(sharedSliceModels).sort((a, b) => {
+      return a.id.localeCompare(b.id);
+    })
   };
 };
 
@@ -1144,13 +1187,22 @@ 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,
+        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");
       }