prismic-ts-codegen 0.1.2 → 0.1.4

package/dist/index.js

@@ -198,10 +198,18 @@ const pascalCase = (input) => pascalCase$1(input, {
   transform: 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": {
@@ -251,12 +259,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,
@@ -460,7 +472,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) => {
@@ -512,12 +530,22 @@ const addInterfacePropertyForField = (config) => {
         for (const choiceId in config.model.config.choices) {
           const choice = config.model.config.choices[choiceId];
           if (choice.type === CustomTypeModelSliceType.SharedSlice) {
-            choiceInterfaceNames.push(buildSharedSliceInterfaceName({ id: choiceId }));
+            choiceInterfaceNames.push(
+              buildSharedSliceInterfaceNamePart({ id: choiceId })
+            );
           } else if (choice.type === 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) => {
@@ -538,7 +566,9 @@ const addInterfacePropertyForField = (config) => {
                           }
                         ]
                       });
-                      writer.writeLine(`Primary content in ${humanReadablePath}`);
+                      writer.writeLine(
+                        `Primary content in ${humanReadablePath}`
+                      );
                     }
                   }
                 ]
@@ -568,7 +598,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) => {
@@ -618,7 +656,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
             });
@@ -627,7 +672,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: [
           {
@@ -698,7 +749,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`
@@ -723,7 +774,7 @@ const addTypeAliasForCustomType = ({
     }
   } else {
     dataInterface = sourceFile.addTypeAlias({
-      name: pascalCase(`${model.id} Document Data`),
+      name: buildTypeName(model.id, "Document", "Data"),
       type: `Record<string, never>`,
       docs: [
         {
@@ -733,7 +784,7 @@ const addTypeAliasForCustomType = ({
     });
   }
   return sourceFile.addTypeAlias({
-    name: pascalCase(`${model.id} Document`),
+    name: buildTypeName(model.id, "Document"),
     typeParameters: [
       {
         name: "Lang",
@@ -749,7 +800,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: [
           {
@@ -769,7 +822,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) => {
@@ -810,7 +867,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) => {
@@ -850,18 +911,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}`
+            );
           }
         }
       ],
@@ -870,7 +936,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: [
       {
@@ -889,9 +955,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: [
       {
@@ -899,8 +965,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}`
+          );
         }
       }
     ],
@@ -946,7 +1016,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
       });
     }