prismic-ts-codegen 0.0.2 → 0.0.5

package/dist/index.cjs

@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 const tsMorph = require('ts-morph');
 const commonTags = require('common-tags');
+const types = require('@prismicio/types');
 const pascalCase$1 = require('pascal-case');
 
 const BLANK_LINE_IDENTIFIER = "// ___BLANK_LINE_TO_BE_REPLACED___";
@@ -32,33 +33,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;
 };
@@ -73,7 +47,7 @@ const isSharedSliceModel = (model) => {
 
 const getAPIIDPath = (config) => {
   return config.path.map((element, i) => {
-    if (isCustomTypeModelField(element.model) && (element.model.type === CustomTypeModelFieldType.Group || element.model.type === CustomTypeModelFieldType.Slices)) {
+    if (isCustomTypeModelField(element.model) && (element.model.type === types.CustomTypeModelFieldType.Group || element.model.type === types.CustomTypeModelFieldType.Slices)) {
       return `${element.id}[]`;
     } else {
       if (element.id === "items") {
@@ -135,10 +109,10 @@ const getHumanReadableFieldType = (config) => {
     }
     case "Link": {
       switch (config.model.config.select) {
-        case CustomTypeModelLinkSelectType.Document: {
+        case types.CustomTypeModelLinkSelectType.Document: {
           return "Content Relationship";
         }
-        case CustomTypeModelLinkSelectType.Media: {
+        case types.CustomTypeModelLinkSelectType.Media: {
           return "Link to Media";
         }
         default: {
@@ -173,6 +147,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}`);
   }
@@ -204,6 +181,7 @@ const buildFieldDocs = (config) => {
           placeholder,
           defaultValue,
           apiIDPath,
+          tabName: config.tabName,
           documentationURL: getFieldDocumentationURL({ model: config.model })
         });
       }
@@ -219,7 +197,7 @@ const buildSharedSliceInterfaceName = (config) => {
   return pascalCase(`${config.id} Slice`);
 };
 
-const addInterfacePropertyFromField = (config) => {
+const addInterfacePropertyForField = (config) => {
   switch (config.model.type) {
     case "UID": {
       break;
@@ -231,7 +209,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -243,7 +222,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -255,7 +235,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -274,7 +255,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -286,7 +268,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -300,7 +283,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -310,7 +294,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -324,33 +309,36 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
     }
     case "Link": {
       switch (config.model.config.select) {
-        case CustomTypeModelLinkSelectType.Document: {
+        case types.CustomTypeModelLinkSelectType.Document: {
           config.interface.addProperty({
             name: config.id,
             type: config.model.config.customtypes && config.model.config.customtypes.length > 0 ? `prismicT.RelationField<${config.model.config.customtypes.map((type) => `"${type}"`).join(" | ")}>` : "prismicT.RelationField",
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
           break;
         }
-        case CustomTypeModelLinkSelectType.Media: {
+        case types.CustomTypeModelLinkSelectType.Media: {
           config.interface.addProperty({
             name: config.id,
             type: "prismicT.LinkToMediaField",
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
           break;
@@ -362,7 +350,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
         }
@@ -376,7 +365,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -390,7 +380,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -400,7 +391,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -416,7 +408,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -426,7 +419,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -439,7 +433,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -451,7 +446,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -474,7 +470,8 @@ const addInterfacePropertyFromField = (config) => {
               writer.writeLine(`Item in ${humanReadablePath}`);
             }
           }
-        ]
+        ],
+        isExported: true
       });
       addInterfacePropertiesForFields({
         interface: itemInterface,
@@ -495,7 +492,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -504,9 +502,9 @@ const addInterfacePropertyFromField = (config) => {
       const choiceInterfaceNames = [];
       for (const choiceId in config.model.config.choices) {
         const choice = config.model.config.choices[choiceId];
-        if (choice.type === CustomTypeModelSliceType.SharedSlice) {
+        if (choice.type === types.CustomTypeModelSliceType.SharedSlice) {
           choiceInterfaceNames.push(buildSharedSliceInterfaceName({ id: choiceId }));
-        } else if (choice.type === CustomTypeModelSliceType.Slice) {
+        } else if (choice.type === types.CustomTypeModelSliceType.Slice) {
           let primaryInterface;
           if (Object.keys(choice["non-repeat"]).length > 0) {
             primaryInterface = config.sourceFile.addInterface({
@@ -585,7 +583,8 @@ const addInterfacePropertyFromField = (config) => {
                     writer.writeLine(`Item in ${humanReadablePath}`);
                   }
                 }
-              ]
+              ],
+              isExported: true
             });
             addInterfacePropertiesForFields({
               interface: itemInterface,
@@ -611,7 +610,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());
         }
@@ -642,7 +642,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -654,7 +655,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
     }
@@ -662,10 +664,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
     });
   }
 };
@@ -692,18 +695,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`),
@@ -812,7 +819,8 @@ const addTypeAliasForSharedSlice = (config) => {
               writer.writeLine(`Item in ${humanReadablePath}`);
             }
           }
-        ]
+        ],
+        isExported: true
       });
       addInterfacePropertiesForFields({
         interface: itemInterface,
@@ -846,7 +854,8 @@ const addTypeAliasForSharedSlice = (config) => {
             writer.writeLine(`- **Documentation**: ${SHARED_SLICES_DOCUMENTATION_URL}`);
           }
         }
-      ]
+      ],
+      isExported: true
     });
     variationTypeNames.push(variationType.getName());
   }
@@ -924,6 +933,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) {
@@ -934,6 +950,37 @@ 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: tsMorph.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);
 };