prismic-ts-codegen 0.0.3 → 0.0.6

package/dist/index.cjs

@@ -147,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}`);
   }
@@ -178,6 +181,7 @@ const buildFieldDocs = (config) => {
           placeholder,
           defaultValue,
           apiIDPath,
+          tabName: config.tabName,
           documentationURL: getFieldDocumentationURL({ model: config.model })
         });
       }
@@ -193,7 +197,7 @@ const buildSharedSliceInterfaceName = (config) => {
   return pascalCase(`${config.id} Slice`);
 };
 
-const addInterfacePropertyFromField = (config) => {
+const addInterfacePropertyForField = (config) => {
   switch (config.model.type) {
     case "UID": {
       break;
@@ -205,7 +209,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -217,7 +222,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -229,7 +235,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -248,7 +255,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -260,7 +268,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -274,7 +283,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -284,7 +294,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -298,7 +309,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -312,7 +324,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
           break;
@@ -324,7 +337,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
           break;
@@ -336,7 +350,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
         }
@@ -350,7 +365,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -364,7 +380,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -374,7 +391,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -390,7 +408,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -400,7 +419,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -413,7 +433,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -425,7 +446,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -470,7 +492,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -619,7 +642,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -631,7 +655,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
     }
@@ -639,10 +664,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
     });
   }
 };
@@ -669,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`),
@@ -903,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) {
@@ -913,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);
 };