prismic-ts-codegen 0.0.6 → 0.1.1

package/README.md

@@ -9,9 +9,7 @@
 
 <!-- TODO: Replacing link to Prismic with [Prismic][prismic] is useful here -->
 
-> ⚠ This project is in an experimental state. Use it at your own risk or stay tuned for the official release!
-
-An experimental Prismic model-to-TypeScript-type generator.
+A Prismic model-to-TypeScript-type generator.
 
 - Converts Custom Type and Shared Slice models to TypeScript types
 - Integrates with other Prismic TypeScript libraries

package/bin/cli.mjs

@@ -5,7 +5,7 @@ import { resolve } from 'path';
 import meow from 'meow';
 import { stripIndent } from 'common-tags';
 import { Project, ModuleDeclarationKind } from 'ts-morph';
-import { CustomTypeModelFieldType, CustomTypeModelLinkSelectType, CustomTypeModelSliceType } from '@prismicio/types';
+import { CustomTypeModelSliceType, CustomTypeModelFieldType, CustomTypeModelLinkSelectType } from '@prismicio/types';
 import { pascalCase as pascalCase$1, pascalCaseTransformMerge } from 'pascal-case';
 import Joi from 'joi';
 import * as prismic from '@prismicio/client';
@@ -37,19 +37,24 @@ const FIELD_DOCUMENTATION_URLS = {
   GeoPoint: "https://prismic.io/docs/core-concepts/geopoint",
   Group: "https://prismic.io/docs/core-concepts/group",
   IntegrationFields: "https://prismic.io/docs/core-concepts/integration-fields",
-  Slices: "https://prismic.io/docs/core-concepts/slices"
+  Slices: "https://prismic.io/docs/core-concepts/slices",
+  LegacySlices: "https://prismic.io/docs/core-concepts/slices"
 };
 
 const isCustomTypeModelField = (model) => {
-  return typeof model === "object" && model !== null && "type" in model && "config" in model;
+  return typeof model === "object" && model !== null && "type" in model;
+};
+
+const hasOwnProperty = (obj, prop) => {
+  return obj.hasOwnProperty(prop);
 };
 
 const isCustomTypeModelSlice = (model) => {
-  return typeof model === "object" && model !== null && "non-repeat" in model && "repeat" in model;
+  return typeof model === "object" && model !== null && hasOwnProperty(model, "type") && model.type === CustomTypeModelSliceType.Slice;
 };
 
 const isSharedSliceModel$1 = (model) => {
-  return typeof model === "object" && model !== null && "variations" in model;
+  return typeof model === "object" && model !== null && hasOwnProperty(model, "type") && model.type === CustomTypeModelSliceType.SharedSlice;
 };
 
 const getAPIIDPath = (config) => {
@@ -78,16 +83,19 @@ const isCustomTypeModel$1 = (model) => {
 
 const getHumanReadableModelName = (config) => {
   if (isCustomTypeModel$1(config.model)) {
-    return config.model.label;
+    return config.model.label || config.model.id;
   } else if (isSharedSliceModel$1(config.model)) {
     return config.model.name;
-  } else if (isCustomTypeModelField(config.model) && "label" in config.model.config) {
-    return config.model.config.label;
+  } else if (isCustomTypeModelField(config.model)) {
+    if (config.model.config && "label" in config.model.config) {
+      return config.model.config.label || config.id;
+    } else if (config.model.config && "fieldset" in config.model) {
+      return config.model.fieldset || config.id;
+    }
   } else if (isCustomTypeModelSlice(config.model)) {
-    return config.model.fieldset;
-  } else {
-    return `Slice Zone (\`${config.id}\`)`;
+    return config.model.fieldset || config.id;
   }
+  return `\`${config.id}\``;
 };
 
 const getHumanReadableFieldPath = (config) => {
@@ -108,14 +116,15 @@ const getHumanReadableFieldPath = (config) => {
 const getHumanReadableFieldType = (config) => {
   switch (config.model.type) {
     case "StructuredText": {
-      const isTitleField = "single" in config.model.config && config.model.config.single.split(",").every((blockType) => /heading/.test(blockType));
+      const isTitleField = config.model.config && "single" in config.model.config && config.model.config.single && config.model.config.single.split(",").every((blockType) => /heading/.test(blockType));
       return isTitleField ? "Title" : "Rich Text";
     }
     case "IntegrationFields": {
-      return `Integration Fields (Catalog: \`${config.model.config.catalog}\`)`;
+      const catalog = config.model.config?.catalog;
+      return `Integration Fields (Catalog: ${catalog ? `\`${catalog}\`` : "*unknown*"})`;
     }
     case "Link": {
-      switch (config.model.config.select) {
+      switch (config.model.config?.select) {
         case CustomTypeModelLinkSelectType.Document: {
           return "Content Relationship";
         }
@@ -176,8 +185,8 @@ const buildFieldDocs = (config) => {
         const fieldType = getHumanReadableFieldType({
           model: config.model
         });
-        const placeholder = "placeholder" in config.model.config && config.model.config.placeholder ? config.model.config.placeholder : `*None*`;
-        const defaultValue = "default_value" in config.model.config ? config.model.config.default_value : void 0;
+        const placeholder = config.model.config && "placeholder" in config.model.config && config.model.config.placeholder ? config.model.config.placeholder : `*None*`;
+        const defaultValue = config.model.config && "default_value" in config.model.config ? config.model.config.default_value : void 0;
         const apiIDPath = getAPIIDPath({
           path: [...config.path, { id: config.id, model: config.model }]
         });
@@ -282,7 +291,7 @@ const addInterfacePropertyForField = (config) => {
       break;
     }
     case "Image": {
-      if (config.model.config.thumbnails.length > 0) {
+      if (config.model.config?.thumbnails && config.model.config.thumbnails.length > 0) {
         const thumbnailNames = config.model.config.thumbnails.map((thumbnail) => `"${thumbnail.name}"`).join(" | ");
         config.interface.addProperty({
           name: config.id,
@@ -309,7 +318,7 @@ const addInterfacePropertyForField = (config) => {
       break;
     }
     case "IntegrationFields": {
-      const catalogType = config.fieldConfigs.integrationFields?.catalogTypes?.[config.model.config.catalog];
+      const catalogType = config.model.config?.catalog ? config.fieldConfigs.integrationFields?.catalogTypes?.[config.model.config.catalog] : void 0;
       config.interface.addProperty({
         name: config.id,
         type: catalogType ? `prismicT.IntegrationFields<${catalogType}>` : "prismicT.IntegrationFields",
@@ -323,11 +332,12 @@ const addInterfacePropertyForField = (config) => {
       break;
     }
     case "Link": {
-      switch (config.model.config.select) {
+      switch (config.model.config?.select) {
         case CustomTypeModelLinkSelectType.Document: {
+          config.model.config;
           config.interface.addProperty({
             name: config.id,
-            type: config.model.config.customtypes && config.model.config.customtypes.length > 0 ? `prismicT.RelationField<${config.model.config.customtypes.map((type) => `"${type}"`).join(" | ")}>` : "prismicT.RelationField",
+            type: "customtypes" in config.model.config && config.model.config.customtypes && config.model.config.customtypes.length > 0 ? `prismicT.RelationField<${config.model.config.customtypes.map((type) => `"${type}"`).join(" | ")}>` : "prismicT.RelationField",
             docs: buildFieldDocs({
               id: config.id,
               model: config.model,
@@ -379,7 +389,7 @@ const addInterfacePropertyForField = (config) => {
       break;
     }
     case "StructuredText": {
-      const isTitleField = "single" in config.model.config && config.model.config.single.split(",").every((blockType) => /heading/.test(blockType));
+      const isTitleField = config.model.config && "single" in config.model.config && config.model.config.single && config.model.config.single.split(",").every((blockType) => /heading/.test(blockType));
       if (isTitleField) {
         config.interface.addProperty({
           name: config.id,
@@ -406,12 +416,12 @@ const addInterfacePropertyForField = (config) => {
       break;
     }
     case "Select": {
-      const options = config.model.config.options.map((option) => `"${option}"`).join(" | ");
-      const hasDefault = Boolean(config.model.config.default_value);
+      const options = config.model.config?.options?.map((option) => `"${option}"`).join(" | ");
+      const hasDefault = Boolean(config.model.config?.default_value);
       if (hasDefault) {
         config.interface.addProperty({
           name: config.id,
-          type: `prismicT.SelectField<${options}, "filled">`,
+          type: `prismicT.SelectField<${options || "string"}, "filled">`,
           docs: buildFieldDocs({
             id: config.id,
             model: config.model,
@@ -480,19 +490,21 @@ const addInterfacePropertyForField = (config) => {
         ],
         isExported: true
       });
-      addInterfacePropertiesForFields({
-        interface: itemInterface,
-        sourceFile: config.sourceFile,
-        fields: config.model.config.fields,
-        path: [
-          ...config.path,
-          {
-            id: config.id,
-            model: config.model
-          }
-        ],
-        fieldConfigs: config.fieldConfigs
-      });
+      if (config.model.config?.fields) {
+        addInterfacePropertiesForFields({
+          interface: itemInterface,
+          sourceFile: config.sourceFile,
+          fields: config.model.config.fields,
+          path: [
+            ...config.path,
+            {
+              id: config.id,
+              model: config.model
+            }
+          ],
+          fieldConfigs: config.fieldConfigs
+        });
+      }
       config.interface.addProperty({
         name: config.id,
         type: `prismicT.GroupField<Simplify<${itemInterface.getName()}>>`,
@@ -507,120 +519,122 @@ const addInterfacePropertyForField = (config) => {
     }
     case "Slices": {
       const choiceInterfaceNames = [];
-      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 }));
-        } else if (choice.type === CustomTypeModelSliceType.Slice) {
-          let primaryInterface;
-          if (Object.keys(choice["non-repeat"]).length > 0) {
-            primaryInterface = config.sourceFile.addInterface({
-              name: pascalCase(`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice Primary`),
-              docs: [
-                {
-                  description: (writer) => {
-                    const humanReadablePath = getHumanReadableFieldPath({
-                      path: [
-                        ...config.path,
-                        {
-                          id: config.id,
-                          model: config.model
-                        },
-                        {
-                          id: choiceId,
-                          model: choice
-                        },
-                        {
-                          id: "primary",
-                          label: "Primary"
-                        }
-                      ]
-                    });
-                    writer.writeLine(`Primary content in ${humanReadablePath}`);
+      if (config.model.config?.choices) {
+        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 }));
+          } 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`),
+                docs: [
+                  {
+                    description: (writer) => {
+                      const humanReadablePath = getHumanReadableFieldPath({
+                        path: [
+                          ...config.path,
+                          {
+                            id: config.id,
+                            model: config.model
+                          },
+                          {
+                            id: choiceId,
+                            model: choice
+                          },
+                          {
+                            id: "primary",
+                            label: "Primary"
+                          }
+                        ]
+                      });
+                      writer.writeLine(`Primary content in ${humanReadablePath}`);
+                    }
                   }
-                }
-              ]
-            });
-            addInterfacePropertiesForFields({
-              interface: primaryInterface,
-              sourceFile: config.sourceFile,
-              fields: choice["non-repeat"],
-              path: [
-                ...config.path,
-                {
-                  id: config.id,
-                  model: config.model
-                },
-                {
-                  id: choiceId,
-                  model: choice
-                },
-                {
-                  id: "primary",
-                  label: "Primary"
-                }
-              ],
-              fieldConfigs: config.fieldConfigs
-            });
-          }
-          let itemInterface;
-          if (Object.keys(choice.repeat).length > 0) {
-            itemInterface = config.sourceFile.addInterface({
-              name: pascalCase(`${config.path[0].id} Document Data ${config.id} ${choiceId} Slice Item`),
-              docs: [
-                {
-                  description: (writer) => {
-                    const humanReadablePath = getHumanReadableFieldPath({
-                      path: [
-                        ...config.path,
-                        {
-                          id: config.id,
-                          model: config.model
-                        },
-                        {
-                          id: choiceId,
-                          model: choice
-                        },
-                        {
-                          id: "items",
-                          label: "Items"
-                        }
-                      ]
-                    });
-                    writer.writeLine(`Item in ${humanReadablePath}`);
+                ]
+              });
+              addInterfacePropertiesForFields({
+                interface: primaryInterface,
+                sourceFile: config.sourceFile,
+                fields: choice["non-repeat"],
+                path: [
+                  ...config.path,
+                  {
+                    id: config.id,
+                    model: config.model
+                  },
+                  {
+                    id: choiceId,
+                    model: choice
+                  },
+                  {
+                    id: "primary",
+                    label: "Primary"
+                  }
+                ],
+                fieldConfigs: config.fieldConfigs
+              });
+            }
+            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`),
+                docs: [
+                  {
+                    description: (writer) => {
+                      const humanReadablePath = getHumanReadableFieldPath({
+                        path: [
+                          ...config.path,
+                          {
+                            id: config.id,
+                            model: config.model
+                          },
+                          {
+                            id: choiceId,
+                            model: choice
+                          },
+                          {
+                            id: "items",
+                            label: "Items"
+                          }
+                        ]
+                      });
+                      writer.writeLine(`Item in ${humanReadablePath}`);
+                    }
+                  }
+                ],
+                isExported: true
+              });
+              addInterfacePropertiesForFields({
+                interface: itemInterface,
+                sourceFile: config.sourceFile,
+                fields: choice.repeat,
+                path: [
+                  ...config.path,
+                  {
+                    id: config.id,
+                    model: config.model
+                  },
+                  {
+                    id: choiceId,
+                    model: choice
+                  },
+                  {
+                    id: "items",
+                    label: "Items"
                   }
-                }
-              ],
+                ],
+                fieldConfigs: config.fieldConfigs
+              });
+            }
+            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"}>`,
               isExported: true
             });
-            addInterfacePropertiesForFields({
-              interface: itemInterface,
-              sourceFile: config.sourceFile,
-              fields: choice.repeat,
-              path: [
-                ...config.path,
-                {
-                  id: config.id,
-                  model: config.model
-                },
-                {
-                  id: choiceId,
-                  model: choice
-                },
-                {
-                  id: "items",
-                  label: "Items"
-                }
-              ],
-              fieldConfigs: config.fieldConfigs
-            });
+            choiceInterfaceNames.push(sliceType.getName());
           }
-          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"}>`,
-            isExported: true
-          });
-          choiceInterfaceNames.push(sliceType.getName());
         }
       }
       const slicesType = config.sourceFile.addTypeAlias({
@@ -673,7 +687,7 @@ const addInterfacePropertiesForFields = (config) => {
   for (const name in config.fields) {
     addInterfacePropertyForField({
       ...config,
-      id: name.includes("-") ? `"${name}"` : name,
+      id: name.includes("-") || /^[0-9]/.test(name) ? `"${name}"` : name,
       model: config.fields[name],
       tabName: config.tabName
     });
@@ -764,7 +778,7 @@ const addTypeAliasForSharedSlice = (config) => {
   const variationTypeNames = [];
   for (const variation of config.model.variations) {
     let primaryInterface;
-    if (Object.keys(variation.primary).length > 0) {
+    if (variation.primary && Object.keys(variation.primary).length > 0) {
       primaryInterface = config.sourceFile.addInterface({
         name: pascalCase(`${buildSharedSliceInterfaceName({ id: config.model.id })} ${variation.id} Primary`),
         docs: [
@@ -805,7 +819,7 @@ const addTypeAliasForSharedSlice = (config) => {
       });
     }
     let itemInterface;
-    if (Object.keys(variation.items).length > 0) {
+    if (variation.items && Object.keys(variation.items).length > 0) {
       itemInterface = config.sourceFile.addInterface({
         name: pascalCase(`${buildSharedSliceInterfaceName({ id: config.model.id })} ${variation.id} Item`),
         docs: [
@@ -1002,9 +1016,9 @@ const configSchema = Joi.object({
   accessToken: Joi.string(),
   customTypesAPIToken: Joi.string(),
   output: Joi.string(),
-  clientIntegration: {
-    includeCreateClientInterface: Joi.boolean
-  },
+  clientIntegration: Joi.object({
+    includeCreateClientInterface: Joi.boolean()
+  }),
   locales: Joi.alternatives(Joi.array().items(Joi.string().required()), Joi.object({
     ids: Joi.array().items(Joi.string().required()),
     fetchFromRepository: Joi.boolean()