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

package/bin/cli.mjs

@@ -15,10 +15,6 @@ import * as prismicCT from '@prismicio/custom-types-client';
 import _jiti from 'jiti';
 
 const BLANK_LINE_IDENTIFIER = "// ___BLANK_LINE_TO_BE_REPLACED___";
-const NON_EDITABLE_FILE_HEADER = 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 = {
@@ -209,10 +205,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": {
@@ -262,12 +266,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,
@@ -471,7 +479,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) => {
@@ -523,12 +537,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) => {
@@ -549,7 +573,9 @@ const addInterfacePropertyForField = (config) => {
                           }
                         ]
                       });
-                      writer.writeLine(`Primary content in ${humanReadablePath}`);
+                      writer.writeLine(
+                        `Primary content in ${humanReadablePath}`
+                      );
                     }
                   }
                 ]
@@ -579,7 +605,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) => {
@@ -629,7 +663,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
             });
@@ -638,7 +679,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: [
           {
@@ -709,7 +756,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`
@@ -734,7 +781,7 @@ const addTypeAliasForCustomType = ({
     }
   } else {
     dataInterface = sourceFile.addTypeAlias({
-      name: pascalCase(`${model.id} Document Data`),
+      name: buildTypeName(model.id, "Document", "Data"),
       type: `Record<string, never>`,
       docs: [
         {
@@ -744,7 +791,7 @@ const addTypeAliasForCustomType = ({
     });
   }
   return sourceFile.addTypeAlias({
-    name: pascalCase(`${model.id} Document`),
+    name: buildTypeName(model.id, "Document"),
     typeParameters: [
       {
         name: "Lang",
@@ -760,7 +807,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: [
           {
@@ -780,7 +829,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) => {
@@ -821,7 +874,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) => {
@@ -861,18 +918,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}`
+            );
           }
         }
       ],
@@ -881,7 +943,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: [
       {
@@ -900,9 +962,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: [
       {
@@ -910,8 +972,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}`
+          );
         }
       }
     ],
@@ -932,8 +998,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({
@@ -957,7 +1022,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
       });
     }
@@ -1039,17 +1106,26 @@ const configSchema = Joi.object({
     includeCreateClientInterface: Joi.boolean(),
     includeContentNamespace: Joi.boolean()
   }),
-  locales: Joi.alternatives(Joi.array().items(Joi.string().required()), Joi.object({
-    ids: Joi.array().items(Joi.string().required()),
-    fetchFromRepository: Joi.boolean()
-  })),
-  models: Joi.alternatives(Joi.array().items(Joi.string()), Joi.object({
-    files: Joi.array().items(Joi.string()),
-    fetchFromRepository: Joi.boolean()
-  })),
+  locales: Joi.alternatives(
+    Joi.array().items(Joi.string().required()),
+    Joi.object({
+      ids: Joi.array().items(Joi.string().required()),
+      fetchFromRepository: Joi.boolean()
+    })
+  ),
+  models: Joi.alternatives(
+    Joi.array().items(Joi.string()),
+    Joi.object({
+      files: Joi.array().items(Joi.string()),
+      fetchFromRepository: Joi.boolean()
+    })
+  ),
   fields: Joi.object({
     embed: Joi.object({
-      providerTypes: Joi.object().pattern(Joi.string(), Joi.string().required())
+      providerTypes: Joi.object().pattern(
+        Joi.string(),
+        Joi.string().required()
+      )
     }),
     integrationFields: Joi.object({
       catalogTypes: Joi.object().pattern(Joi.string(), Joi.string().required())
@@ -1128,6 +1204,10 @@ const loadModels = async (config) => {
 };
 
 const jiti = _jiti(process.cwd());
+const loadModuleWithJiti = (id) => {
+  const mod = jiti(id);
+  return "default" in mod ? mod.default : mod;
+};
 const DEFAULT_CONFIG_PATHS = [
   "prismicCodegen.config.ts",
   "prismicCodegen.config.js"
@@ -1135,22 +1215,24 @@ const DEFAULT_CONFIG_PATHS = [
 const loadConfig = (config) => {
   if (config.path) {
     if (existsSync(config.path)) {
-      return jiti(config.path);
+      return loadModuleWithJiti(resolve(config.path));
     } else {
       throw new Error(`Config file does not exist: ${config.path}`);
     }
   } else {
     for (const configPath of DEFAULT_CONFIG_PATHS) {
       if (existsSync(configPath)) {
-        const mod = jiti(resolve(configPath));
-        return "default" in mod ? mod.default : mod;
+        return loadModuleWithJiti(resolve(configPath));
       }
     }
   }
   return {};
 };
 
-const cli = meow(`
+const NON_EDITABLE_FILE_HEADER = "// Code generated by prismic-ts-codegen. DO NOT EDIT.";
+
+const cli = meow(
+  `
 	Usage:
 	    prismic-ts-codegen [options...]
 	    prismic-ts-codegen init [options...]
@@ -1160,16 +1242,18 @@ const cli = meow(`
 
 	Options:
 	    -c, --config <path>  Path to a prismic-ts-codegen configuration file.
-	`, {
-  importMeta: import.meta,
-  flags: {
-    config: {
-      type: "string",
-      alias: "c",
-      isRequired: false
+	`,
+  {
+    importMeta: import.meta,
+    flags: {
+      config: {
+        type: "string",
+        alias: "c",
+        isRequired: false
+      }
     }
   }
-});
+);
 const main = async () => {
   if (cli.input[0] === "init") {
     const configPath = cli.flags.config || "prismicCodegen.config.ts";
@@ -1221,6 +1305,11 @@ Created prismic-ts-codegen config file: ${configPath}`);
         fetchFromRepository: config.locales && "fetchFromRepository" in config.locales && config.locales.fetchFromRepository
       });
       const hasCustomTypeModels = customTypeModels.length > 0;
+      if (config.clientIntegration?.includeCreateClientInterface && !hasCustomTypeModels) {
+        console.info(
+          "[INFO]: prismic-ts-codegen was configured to automatically integrate with `@prismicio/client`, but the integration was not generated because no Custom Type models were found. Automatic integration requires at least one Custom Type model."
+        );
+      }
       const types = generateTypes({
         customTypeModels,
         sharedSliceModels,
@@ -1231,11 +1320,11 @@ Created prismic-ts-codegen config file: ${configPath}`);
           includeContentNamespace: config.clientIntegration?.includeContentNamespace ?? true
         }
       });
-      if (config.clientIntegration?.includeCreateClientInterface && !hasCustomTypeModels) {
-        console.info("[INFO]: prismic-ts-codegen was configured to automatically integrate with `@prismicio/client`, but the integration was not generated because no Custom Type models were found. Automatic integration requires at least one Custom Type model.");
-      }
+      const fileContents = `${NON_EDITABLE_FILE_HEADER}
+
+${types}`;
       if (config.output) {
-        writeFileSync(resolve(config.output), types);
+        writeFileSync(resolve(config.output), fileContents);
         console.info(`
 Generated types in: ${config.output}`);
       } else {