prismic-ts-codegen 0.0.2 → 0.0.5

package/dist/index.js

@@ -1,5 +1,6 @@
-import { Project } from 'ts-morph';
+import { Project, ModuleDeclarationKind } from 'ts-morph';
 import { stripIndent } from 'common-tags';
+import { CustomTypeModelFieldType, CustomTypeModelLinkSelectType, CustomTypeModelSliceType } from '@prismicio/types';
 import { pascalCase as pascalCase$1, pascalCaseTransformMerge } from 'pascal-case';
 
 const BLANK_LINE_IDENTIFIER = "// ___BLANK_LINE_TO_BE_REPLACED___";
@@ -28,33 +29,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;
 };
@@ -169,6 +143,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}`);
   }
@@ -200,6 +177,7 @@ const buildFieldDocs = (config) => {
           placeholder,
           defaultValue,
           apiIDPath,
+          tabName: config.tabName,
           documentationURL: getFieldDocumentationURL({ model: config.model })
         });
       }
@@ -215,7 +193,7 @@ const buildSharedSliceInterfaceName = (config) => {
   return pascalCase(`${config.id} Slice`);
 };
 
-const addInterfacePropertyFromField = (config) => {
+const addInterfacePropertyForField = (config) => {
   switch (config.model.type) {
     case "UID": {
       break;
@@ -227,7 +205,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -239,7 +218,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -251,7 +231,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -270,7 +251,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -282,7 +264,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -296,7 +279,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -306,7 +290,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -320,7 +305,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -334,7 +320,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
           break;
@@ -346,7 +333,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
           break;
@@ -358,7 +346,8 @@ const addInterfacePropertyFromField = (config) => {
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
-              path: config.path
+              path: config.path,
+              tabName: config.tabName
             })
           });
         }
@@ -372,7 +361,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -386,7 +376,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -396,7 +387,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -412,7 +404,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       } else {
@@ -422,7 +415,8 @@ const addInterfacePropertyFromField = (config) => {
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
-            path: config.path
+            path: config.path,
+            tabName: config.tabName
           })
         });
       }
@@ -435,7 +429,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -447,7 +442,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -470,7 +466,8 @@ const addInterfacePropertyFromField = (config) => {
               writer.writeLine(`Item in ${humanReadablePath}`);
             }
           }
-        ]
+        ],
+        isExported: true
       });
       addInterfacePropertiesForFields({
         interface: itemInterface,
@@ -491,7 +488,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -581,7 +579,8 @@ const addInterfacePropertyFromField = (config) => {
                     writer.writeLine(`Item in ${humanReadablePath}`);
                   }
                 }
-              ]
+              ],
+              isExported: true
             });
             addInterfacePropertiesForFields({
               interface: itemInterface,
@@ -607,7 +606,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());
         }
@@ -638,7 +638,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
       break;
@@ -650,7 +651,8 @@ const addInterfacePropertyFromField = (config) => {
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
-          path: config.path
+          path: config.path,
+          tabName: config.tabName
         })
       });
     }
@@ -658,10 +660,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
     });
   }
 };
@@ -688,18 +691,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`),
@@ -808,7 +815,8 @@ const addTypeAliasForSharedSlice = (config) => {
               writer.writeLine(`Item in ${humanReadablePath}`);
             }
           }
-        ]
+        ],
+        isExported: true
       });
       addInterfacePropertiesForFields({
         interface: itemInterface,
@@ -842,7 +850,8 @@ const addTypeAliasForSharedSlice = (config) => {
             writer.writeLine(`- **Documentation**: ${SHARED_SLICES_DOCUMENTATION_URL}`);
           }
         }
-      ]
+      ],
+      isExported: true
     });
     variationTypeNames.push(variationType.getName());
   }
@@ -920,6 +929,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) {
@@ -930,6 +946,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: 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);
 };