prismic-ts-codegen 0.1.3-alpha.0 → 0.1.5

package/dist/index.cjs

@@ -3,15 +3,10 @@
 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___";
-const NON_EDITABLE_FILE_HEADER = commonTags.stripIndent`
-	// Code generated by prismic-ts-codegen. DO NOT EDIT.
-	${BLANK_LINE_IDENTIFIER}
-`;
 const CUSTOM_TYPES_DOCUMENTATION_URL = "https://prismic.io/docs/core-concepts/custom-types";
 const SHARED_SLICES_DOCUMENTATION_URL = "https://prismic.io/docs/core-concepts/reusing-slices";
 const FIELD_DOCUMENTATION_URLS = {
@@ -202,10 +197,18 @@ const pascalCase = (input) => pascalCase$1.pascalCase(input, {
   transform: pascalCase$1.pascalCaseTransformMerge
 });
 
-const buildSharedSliceInterfaceName = (config) => {
+const buildSharedSliceInterfaceNamePart = (config) => {
   return pascalCase(`${config.id} Slice`);
 };
 
+const buildTypeName = (...parts) => {
+  let name = pascalCase(parts.filter(Boolean).join(" "));
+  if (/^[0-9]/.test(name) ? "_" : "") {
+    name = `_${name}`;
+  }
+  return name;
+};
+
 const addInterfacePropertyForField = (config) => {
   switch (config.model.type) {
     case "UID": {
@@ -255,12 +258,16 @@ const addInterfacePropertyForField = (config) => {
       if (config.fieldConfigs.embed?.providerTypes) {
         for (const providerType in config.fieldConfigs.embed?.providerTypes) {
           const configuredProviderType = config.fieldConfigs.embed?.providerTypes[providerType];
-          providerTypes.push(`({ provider_name: "${providerType}" } & ${configuredProviderType})`);
+          providerTypes.push(
+            `({ provider_name: "${providerType}" } & ${configuredProviderType})`
+          );
         }
       }
       config.interface.addProperty({
         name: config.id,
-        type: providerTypes.length > 0 ? `prismicT.EmbedField<prismicT.AnyOEmbed & prismicT.OEmbedExtra & (${providerTypes.join(" | ")})>` : "prismicT.EmbedField",
+        type: providerTypes.length > 0 ? `prismicT.EmbedField<prismicT.AnyOEmbed & prismicT.OEmbedExtra & (${providerTypes.join(
+          " | "
+        )})>` : "prismicT.EmbedField",
         docs: buildFieldDocs({
           id: config.id,
           model: config.model,
@@ -464,7 +471,13 @@ const addInterfacePropertyForField = (config) => {
     }
     case "Group": {
       const itemInterface = config.sourceFile.addInterface({
-        name: pascalCase(`${config.path[0].id} Document Data ${config.id} Item`),
+        name: buildTypeName(
+          config.path[0].id,
+          "Document",
+          "Data",
+          config.id,
+          "Item"
+        ),
         docs: [
           {
             description: (writer) => {
@@ -516,12 +529,22 @@ const addInterfacePropertyForField = (config) => {
         for (const choiceId in config.model.config.choices) {
           const choice = config.model.config.choices[choiceId];
           if (choice.type === types.CustomTypeModelSliceType.SharedSlice) {
-            choiceInterfaceNames.push(buildSharedSliceInterfaceName({ id: choiceId }));
+            choiceInterfaceNames.push(
+              buildSharedSliceInterfaceNamePart({ id: choiceId })
+            );
           } else if (choice.type === types.CustomTypeModelSliceType.Slice) {
             let primaryInterface;
             if (choice["non-repeat"] && Object.keys(choice["non-repeat"]).length > 0) {
               primaryInterface = config.sourceFile.addInterface({
-                name: pascalCase(`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice Primary`),
+                name: buildTypeName(
+                  config.path[0].id,
+                  "Document",
+                  "Data",
+                  config.id,
+                  choiceId,
+                  "Slice",
+                  "Primary"
+                ),
                 docs: [
                   {
                     description: (writer) => {
@@ -542,7 +565,9 @@ const addInterfacePropertyForField = (config) => {
                           }
                         ]
                       });
-                      writer.writeLine(`Primary content in ${humanReadablePath}`);
+                      writer.writeLine(
+                        `Primary content in ${humanReadablePath}`
+                      );
                     }
                   }
                 ]
@@ -572,7 +597,15 @@ const addInterfacePropertyForField = (config) => {
             let itemInterface;
             if (choice.repeat && Object.keys(choice.repeat).length > 0) {
               itemInterface = config.sourceFile.addInterface({
-                name: pascalCase(`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice Item`),
+                name: buildTypeName(
+                  config.path[0].id,
+                  "Document",
+                  "Data",
+                  config.id,
+                  choiceId,
+                  "Slice",
+                  "Item"
+                ),
                 docs: [
                   {
                     description: (writer) => {
@@ -622,7 +655,14 @@ const addInterfacePropertyForField = (config) => {
               });
             }
             const sliceType = config.sourceFile.addTypeAlias({
-              name: pascalCase(`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice`),
+              name: buildTypeName(
+                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"}>`,
               isExported: true
             });
@@ -631,7 +671,13 @@ const addInterfacePropertyForField = (config) => {
         }
       }
       const slicesType = config.sourceFile.addTypeAlias({
-        name: pascalCase(`${config.path[0].id} Document Data ${config.id} Slice`),
+        name: buildTypeName(
+          config.path[0].id,
+          "Document",
+          "Data",
+          config.id,
+          "Slice"
+        ),
         type: choiceInterfaceNames.length > 0 ? choiceInterfaceNames.join(" | ") : "never",
         docs: [
           {
@@ -702,7 +748,7 @@ const addTypeAliasForCustomType = ({
   let dataInterface;
   if (hasDataFields) {
     dataInterface = sourceFile.addInterface({
-      name: pascalCase(`${model.id} Document Data`),
+      name: buildTypeName(model.id, "Document", "Data"),
       docs: [
         {
           description: `Content for ${model.label} documents`
@@ -727,7 +773,7 @@ const addTypeAliasForCustomType = ({
     }
   } else {
     dataInterface = sourceFile.addTypeAlias({
-      name: pascalCase(`${model.id} Document Data`),
+      name: buildTypeName(model.id, "Document", "Data"),
       type: `Record<string, never>`,
       docs: [
         {
@@ -737,7 +783,7 @@ const addTypeAliasForCustomType = ({
     });
   }
   return sourceFile.addTypeAlias({
-    name: pascalCase(`${model.id} Document`),
+    name: buildTypeName(model.id, "Document"),
     typeParameters: [
       {
         name: "Lang",
@@ -753,7 +799,9 @@ const addTypeAliasForCustomType = ({
           writer.blankLine();
           writer.writeLine(`- **API ID**: \`${model.id}\``);
           writer.writeLine(`- **Repeatable**: \`${model.repeatable}\``);
-          writer.writeLine(`- **Documentation**: ${CUSTOM_TYPES_DOCUMENTATION_URL}`);
+          writer.writeLine(
+            `- **Documentation**: ${CUSTOM_TYPES_DOCUMENTATION_URL}`
+          );
         },
         tags: [
           {
@@ -773,7 +821,11 @@ const addTypeAliasForSharedSlice = (config) => {
     let primaryInterface;
     if (variation.primary && Object.keys(variation.primary).length > 0) {
       primaryInterface = config.sourceFile.addInterface({
-        name: pascalCase(`${buildSharedSliceInterfaceName({ id: config.model.id })} ${variation.id} Primary`),
+        name: buildTypeName(
+          buildSharedSliceInterfaceNamePart({ id: config.model.id }),
+          variation.id,
+          "Primary"
+        ),
         docs: [
           {
             description: (writer) => {
@@ -814,7 +866,11 @@ const addTypeAliasForSharedSlice = (config) => {
     let itemInterface;
     if (variation.items && Object.keys(variation.items).length > 0) {
       itemInterface = config.sourceFile.addInterface({
-        name: pascalCase(`${buildSharedSliceInterfaceName({ id: config.model.id })} ${variation.id} Item`),
+        name: buildTypeName(
+          buildSharedSliceInterfaceNamePart({ id: config.model.id }),
+          variation.id,
+          "Item"
+        ),
         docs: [
           {
             description: (writer) => {
@@ -854,18 +910,23 @@ const addTypeAliasForSharedSlice = (config) => {
       });
     }
     const variationType = config.sourceFile.addTypeAlias({
-      name: pascalCase(`${buildSharedSliceInterfaceName({
-        id: config.model.id
-      })} ${variation.id}`),
+      name: buildTypeName(
+        buildSharedSliceInterfaceNamePart({ id: config.model.id }),
+        variation.id
+      ),
       type: `prismicT.SharedSliceVariation<"${variation.id}", ${primaryInterface ? `Simplify<${primaryInterface.getName()}>` : "Record<string, never>"}, ${itemInterface ? `Simplify<${itemInterface.getName()}>` : "never"}>`,
       docs: [
         {
           description: (writer) => {
-            writer.writeLine(`${variation.name} variation for ${config.model.name} Slice`);
+            writer.writeLine(
+              `${variation.name} variation for ${config.model.name} Slice`
+            );
             writer.blankLine();
             writer.writeLine(`- **API ID**: \`${variation.id}\``);
             writer.writeLine(`- **Description**: \`${variation.description}\``);
-            writer.writeLine(`- **Documentation**: ${SHARED_SLICES_DOCUMENTATION_URL}`);
+            writer.writeLine(
+              `- **Documentation**: ${SHARED_SLICES_DOCUMENTATION_URL}`
+            );
           }
         }
       ],
@@ -874,7 +935,7 @@ const addTypeAliasForSharedSlice = (config) => {
     variationTypeNames.push(variationType.getName());
   }
   const variationsType = config.sourceFile.addTypeAlias({
-    name: pascalCase(`${config.model.id} Slice Variation`),
+    name: buildTypeName(config.model.id, "Slice", "Variation"),
     type: variationTypeNames.length > 0 ? variationTypeNames.join(" | ") : "never",
     docs: [
       {
@@ -893,9 +954,9 @@ const addTypeAliasForSharedSlice = (config) => {
     ]
   });
   return config.sourceFile.addTypeAlias({
-    name: pascalCase(buildSharedSliceInterfaceName({
-      id: config.model.id
-    })),
+    name: buildTypeName(
+      buildSharedSliceInterfaceNamePart({ id: config.model.id })
+    ),
     type: `prismicT.SharedSlice<"${config.model.id}", ${variationsType.getName()}>`,
     docs: [
       {
@@ -903,8 +964,12 @@ const addTypeAliasForSharedSlice = (config) => {
           writer.writeLine(`${config.model.name} Shared Slice`);
           writer.blankLine();
           writer.writeLine(`- **API ID**: \`${config.model.id}\``);
-          writer.writeLine(`- **Description**: \`${config.model.description}\``);
-          writer.writeLine(`- **Documentation**: ${SHARED_SLICES_DOCUMENTATION_URL}`);
+          writer.writeLine(
+            `- **Description**: \`${config.model.description}\``
+          );
+          writer.writeLine(
+            `- **Documentation**: ${SHARED_SLICES_DOCUMENTATION_URL}`
+          );
         }
       }
     ],
@@ -925,8 +990,7 @@ const generateTypes = (config = {}) => {
   sourceFile.addImportDeclaration({
     moduleSpecifier: "@prismicio/types",
     namespaceImport: "prismicT",
-    isTypeOnly: true,
-    leadingTrivia: NON_EDITABLE_FILE_HEADER
+    isTypeOnly: true
   });
   sourceFile.addStatements(BLANK_LINE_IDENTIFIER);
   const simplifyTypeAlias = sourceFile.addTypeAlias({
@@ -950,7 +1014,9 @@ const generateTypes = (config = {}) => {
     if (config.customTypeModels.length > 0) {
       sourceFile.addTypeAlias({
         name: "AllDocumentTypes",
-        type: config.customTypeModels.map((customTypeModel) => pascalCase(`${customTypeModel.id} Document`)).join(" | "),
+        type: config.customTypeModels.map(
+          (customTypeModel) => buildTypeName(customTypeModel.id, "Document")
+        ).join(" | "),
         isExported: true
       });
     }