prismic-ts-codegen 0.0.2 → 0.0.3

package/README.md

@@ -20,7 +20,7 @@ An experimental Prismic model-to-TypeScript-type generator.
 ## Install
 
 ```bash
-npm install --save-dev prismic-ts-codegen
+npm install --save-dev prismic-ts-codegen @prismicio/types
 ```
 
 ## Usage
@@ -62,7 +62,56 @@ npm install --save-dev prismic-ts-codegen
 
 ## Documentation
 
-To discover what's new on this package check out [the changelog][changelog]. For full documentation, visit the [official Prismic documentation][prismic-docs].
+### Configuration
+
+`prismic-ts-codegen` is configured using a `prismicCodegen.config.ts` file. It must export a configuration object as the default export.
+
+#### Interface
+
+See the [`Config` TypeScript interface](./src/cli/types.ts) for a complete reference of each configuration property.
+
+#### Full example
+
+```typescript
+// prismicCodegen.config.ts
+
+import type { Config } from "prismic-ts-codegen";
+
+const config: Config = {
+	repositoryName: "nextjs-blog-demo",
+	accessToken: "abc123xyz345",
+	customTypesAPIToken: "abc123xyz345",
+
+	output: "./types.generated.ts",
+
+	locales: {
+		ids: ["en-us", "fr-fr", "en-gb"],
+		fetchFromRepository: true,
+	},
+
+	models: {
+		files: ["./customtypes/**/index.json", "./slices/**/model.json"],
+		fetchFromRepository: true,
+	},
+
+	fields: {
+		embed: {
+			providerTypes: {
+				YouTube: 'import("./types").OEmbedYouTube',
+				Twitter: 'import("./types").OEmbedTwitter',
+				Vimeo: 'import("./types").OEmbedVimeo',
+			},
+		},
+		integrationFields: {
+			catalogTypes: {
+				shop: 'import("./types").IntegrationFieldShop',
+			},
+		},
+	},
+};
+
+export default config;
+```
 
 ## Contributing
 

package/bin/cli.mjs

@@ -5,6 +5,7 @@ import { resolve } from 'path';
 import meow from 'meow';
 import { stripIndent } from 'common-tags';
 import { Project } from 'ts-morph';
+import { CustomTypeModelFieldType, CustomTypeModelLinkSelectType, CustomTypeModelSliceType } from '@prismicio/types';
 import { pascalCase as pascalCase$1, pascalCaseTransformMerge } from 'pascal-case';
 import Joi from 'joi';
 import * as prismic from '@prismicio/client';
@@ -39,33 +40,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;
 };
@@ -481,7 +455,8 @@ const addInterfacePropertyFromField = (config) => {
               writer.writeLine(`Item in ${humanReadablePath}`);
             }
           }
-        ]
+        ],
+        isExported: true
       });
       addInterfacePropertiesForFields({
         interface: itemInterface,
@@ -592,7 +567,8 @@ const addInterfacePropertyFromField = (config) => {
                     writer.writeLine(`Item in ${humanReadablePath}`);
                   }
                 }
-              ]
+              ],
+              isExported: true
             });
             addInterfacePropertiesForFields({
               interface: itemInterface,
@@ -618,7 +594,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());
         }
@@ -671,7 +648,7 @@ const addInterfacePropertiesForFields = (config) => {
   for (const name in config.fields) {
     addInterfacePropertyFromField({
       ...config,
-      id: name,
+      id: name.includes("-") ? `"${name}"` : name,
       model: config.fields[name]
     });
   }
@@ -819,7 +796,8 @@ const addTypeAliasForSharedSlice = (config) => {
               writer.writeLine(`Item in ${humanReadablePath}`);
             }
           }
-        ]
+        ],
+        isExported: true
       });
       addInterfacePropertiesForFields({
         interface: itemInterface,
@@ -853,7 +831,8 @@ const addTypeAliasForSharedSlice = (config) => {
             writer.writeLine(`- **Documentation**: ${SHARED_SLICES_DOCUMENTATION_URL}`);
           }
         }
-      ]
+      ],
+      isExported: true
     });
     variationTypeNames.push(variationType.getName());
   }
@@ -1023,7 +1002,7 @@ const loadModels = async (config) => {
     });
     if (config.fetchFromRepository) {
       const [remoteCustomTypeModels, remoteSharedSliceModels] = await Promise.all([
-        customTypesClient.getAll(),
+        customTypesClient.getAllCustomTypes(),
         customTypesClient.getAllSharedSlices()
       ]);
       for (const customTypeModel of remoteCustomTypeModels) {
@@ -1045,8 +1024,12 @@ const loadModels = async (config) => {
     }
   }
   return {
-    customTypeModels: Object.values(customTypeModels),
-    sharedSliceModels: Object.values(sharedSliceModels)
+    customTypeModels: Object.values(customTypeModels).sort((a, b) => {
+      return a.id.localeCompare(b.id);
+    }),
+    sharedSliceModels: Object.values(sharedSliceModels).sort((a, b) => {
+      return a.id.localeCompare(b.id);
+    })
   };
 };
 

package/dist/index.cjs

@@ -4,6 +4,7 @@ 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___";
@@ -32,33 +33,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;
 };
@@ -73,7 +47,7 @@ const isSharedSliceModel = (model) => {
 
 const getAPIIDPath = (config) => {
   return config.path.map((element, i) => {
-    if (isCustomTypeModelField(element.model) && (element.model.type === CustomTypeModelFieldType.Group || element.model.type === CustomTypeModelFieldType.Slices)) {
+    if (isCustomTypeModelField(element.model) && (element.model.type === types.CustomTypeModelFieldType.Group || element.model.type === types.CustomTypeModelFieldType.Slices)) {
       return `${element.id}[]`;
     } else {
       if (element.id === "items") {
@@ -135,10 +109,10 @@ const getHumanReadableFieldType = (config) => {
     }
     case "Link": {
       switch (config.model.config.select) {
-        case CustomTypeModelLinkSelectType.Document: {
+        case types.CustomTypeModelLinkSelectType.Document: {
           return "Content Relationship";
         }
-        case CustomTypeModelLinkSelectType.Media: {
+        case types.CustomTypeModelLinkSelectType.Media: {
           return "Link to Media";
         }
         default: {
@@ -331,7 +305,7 @@ const addInterfacePropertyFromField = (config) => {
     }
     case "Link": {
       switch (config.model.config.select) {
-        case CustomTypeModelLinkSelectType.Document: {
+        case types.CustomTypeModelLinkSelectType.Document: {
           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",
@@ -343,7 +317,7 @@ const addInterfacePropertyFromField = (config) => {
           });
           break;
         }
-        case CustomTypeModelLinkSelectType.Media: {
+        case types.CustomTypeModelLinkSelectType.Media: {
           config.interface.addProperty({
             name: config.id,
             type: "prismicT.LinkToMediaField",
@@ -474,7 +448,8 @@ const addInterfacePropertyFromField = (config) => {
               writer.writeLine(`Item in ${humanReadablePath}`);
             }
           }
-        ]
+        ],
+        isExported: true
       });
       addInterfacePropertiesForFields({
         interface: itemInterface,
@@ -504,9 +479,9 @@ const addInterfacePropertyFromField = (config) => {
       const choiceInterfaceNames = [];
       for (const choiceId in config.model.config.choices) {
         const choice = config.model.config.choices[choiceId];
-        if (choice.type === CustomTypeModelSliceType.SharedSlice) {
+        if (choice.type === types.CustomTypeModelSliceType.SharedSlice) {
           choiceInterfaceNames.push(buildSharedSliceInterfaceName({ id: choiceId }));
-        } else if (choice.type === CustomTypeModelSliceType.Slice) {
+        } else if (choice.type === types.CustomTypeModelSliceType.Slice) {
           let primaryInterface;
           if (Object.keys(choice["non-repeat"]).length > 0) {
             primaryInterface = config.sourceFile.addInterface({
@@ -585,7 +560,8 @@ const addInterfacePropertyFromField = (config) => {
                     writer.writeLine(`Item in ${humanReadablePath}`);
                   }
                 }
-              ]
+              ],
+              isExported: true
             });
             addInterfacePropertiesForFields({
               interface: itemInterface,
@@ -611,7 +587,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());
         }
@@ -664,7 +641,7 @@ const addInterfacePropertiesForFields = (config) => {
   for (const name in config.fields) {
     addInterfacePropertyFromField({
       ...config,
-      id: name,
+      id: name.includes("-") ? `"${name}"` : name,
       model: config.fields[name]
     });
   }
@@ -812,7 +789,8 @@ const addTypeAliasForSharedSlice = (config) => {
               writer.writeLine(`Item in ${humanReadablePath}`);
             }
           }
-        ]
+        ],
+        isExported: true
       });
       addInterfacePropertiesForFields({
         interface: itemInterface,
@@ -846,7 +824,8 @@ const addTypeAliasForSharedSlice = (config) => {
             writer.writeLine(`- **Documentation**: ${SHARED_SLICES_DOCUMENTATION_URL}`);
           }
         }
-      ]
+      ],
+      isExported: true
     });
     variationTypeNames.push(variationType.getName());
   }