prismic-ts-codegen 0.1.4 → 0.1.6

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 = {
@@ -738,7 +734,7 @@ const addInterfacePropertiesForFields = (config) => {
   for (const name in config.fields) {
     addInterfacePropertyForField({
       ...config,
-      id: name.includes("-") || /^[0-9]/.test(name) ? `"${name}"` : name,
+      id: name.includes("-") || name.includes(":") || /^[0-9]/.test(name) ? `"${name}"` : name,
       model: config.fields[name],
       tabName: config.tabName
     });
@@ -1002,11 +998,10 @@ const generateTypes = (config = {}) => {
   sourceFile.addImportDeclaration({
     moduleSpecifier: "@prismicio/types",
     namespaceImport: "prismicT",
-    isTypeOnly: true,
-    leadingTrivia: NON_EDITABLE_FILE_HEADER
+    isTypeOnly: true
   });
   sourceFile.addStatements(BLANK_LINE_IDENTIFIER);
-  sourceFile.addTypeAlias({
+  const simplifyTypeAlias = sourceFile.addTypeAlias({
     name: "Simplify",
     typeParameters: [
       {
@@ -1043,7 +1038,7 @@ const generateTypes = (config = {}) => {
       });
     }
   }
-  if (config.clientIntegration?.includeCreateClientInterface) {
+  if (config.clientIntegration?.includeCreateClientInterface || config.clientIntegration?.includeContentNamespace) {
     sourceFile.addImportDeclaration({
       moduleSpecifier: "@prismicio/client",
       namespaceImport: "prismic",
@@ -1054,25 +1049,44 @@ const generateTypes = (config = {}) => {
       hasDeclareKeyword: true,
       declarationKind: ModuleDeclarationKind.Module
     });
-    clientModuleDeclaration.addInterface({
-      name: "CreateClient",
-      callSignatures: [
-        {
-          parameters: [
-            {
-              name: "repositoryNameOrEndpoint",
-              type: "string"
-            },
-            {
-              name: "options",
-              type: "prismic.ClientConfig",
-              hasQuestionToken: true
-            }
-          ],
-          returnType: (config.customTypeModels?.length || 0) > 0 ? "prismic.Client<AllDocumentTypes>" : "prismic.Client"
-        }
-      ]
-    });
+    if (config.clientIntegration.includeCreateClientInterface) {
+      clientModuleDeclaration.addInterface({
+        name: "CreateClient",
+        callSignatures: [
+          {
+            parameters: [
+              {
+                name: "repositoryNameOrEndpoint",
+                type: "string"
+              },
+              {
+                name: "options",
+                type: "prismic.ClientConfig",
+                hasQuestionToken: true
+              }
+            ],
+            returnType: (config.customTypeModels?.length || 0) > 0 ? "prismic.Client<AllDocumentTypes>" : "prismic.Client"
+          }
+        ]
+      });
+    }
+    if (config.clientIntegration.includeContentNamespace) {
+      const contentNamespaceDeclaration = clientModuleDeclaration.addModule({
+        name: "Content",
+        declarationKind: ModuleDeclarationKind.Namespace
+      });
+      const exportSymbols = sourceFile.getExportSymbols().filter((exportSymbol) => {
+        return exportSymbol.getName() !== simplifyTypeAlias.getName();
+      });
+      contentNamespaceDeclaration.addExportDeclaration({
+        isTypeOnly: true,
+        namedExports: exportSymbols.map((exportSymbol) => {
+          return {
+            name: exportSymbol.getName()
+          };
+        })
+      });
+    }
   }
   return getSourceFileText(sourceFile);
 };
@@ -1089,7 +1103,8 @@ const configSchema = Joi.object({
   customTypesAPIToken: Joi.string(),
   output: Joi.string(),
   clientIntegration: Joi.object({
-    includeCreateClientInterface: Joi.boolean()
+    includeCreateClientInterface: Joi.boolean(),
+    includeContentNamespace: Joi.boolean()
   }),
   locales: Joi.alternatives(
     Joi.array().items(Joi.string().required()),
@@ -1214,6 +1229,8 @@ const loadConfig = (config) => {
   return {};
 };
 
+const NON_EDITABLE_FILE_HEADER = "// Code generated by prismic-ts-codegen. DO NOT EDIT.";
+
 const cli = meow(
   `
 	Usage:
@@ -1288,22 +1305,26 @@ 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,
         localeIDs,
         fieldConfigs: config.fields,
         clientIntegration: {
-          includeCreateClientInterface: hasCustomTypeModels ? config.clientIntegration?.includeCreateClientInterface ?? true : false
+          includeCreateClientInterface: hasCustomTypeModels ? config.clientIntegration?.includeCreateClientInterface ?? true : false,
+          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 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 {

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 = {
@@ -731,7 +726,7 @@ const addInterfacePropertiesForFields = (config) => {
   for (const name in config.fields) {
     addInterfacePropertyForField({
       ...config,
-      id: name.includes("-") || /^[0-9]/.test(name) ? `"${name}"` : name,
+      id: name.includes("-") || name.includes(":") || /^[0-9]/.test(name) ? `"${name}"` : name,
       model: config.fields[name],
       tabName: config.tabName
     });
@@ -995,11 +990,10 @@ const generateTypes = (config = {}) => {
   sourceFile.addImportDeclaration({
     moduleSpecifier: "@prismicio/types",
     namespaceImport: "prismicT",
-    isTypeOnly: true,
-    leadingTrivia: NON_EDITABLE_FILE_HEADER
+    isTypeOnly: true
   });
   sourceFile.addStatements(BLANK_LINE_IDENTIFIER);
-  sourceFile.addTypeAlias({
+  const simplifyTypeAlias = sourceFile.addTypeAlias({
     name: "Simplify",
     typeParameters: [
       {
@@ -1036,7 +1030,7 @@ const generateTypes = (config = {}) => {
       });
     }
   }
-  if (config.clientIntegration?.includeCreateClientInterface) {
+  if (config.clientIntegration?.includeCreateClientInterface || config.clientIntegration?.includeContentNamespace) {
     sourceFile.addImportDeclaration({
       moduleSpecifier: "@prismicio/client",
       namespaceImport: "prismic",
@@ -1047,25 +1041,44 @@ const generateTypes = (config = {}) => {
       hasDeclareKeyword: true,
       declarationKind: tsMorph.ModuleDeclarationKind.Module
     });
-    clientModuleDeclaration.addInterface({
-      name: "CreateClient",
-      callSignatures: [
-        {
-          parameters: [
-            {
-              name: "repositoryNameOrEndpoint",
-              type: "string"
-            },
-            {
-              name: "options",
-              type: "prismic.ClientConfig",
-              hasQuestionToken: true
-            }
-          ],
-          returnType: (config.customTypeModels?.length || 0) > 0 ? "prismic.Client<AllDocumentTypes>" : "prismic.Client"
-        }
-      ]
-    });
+    if (config.clientIntegration.includeCreateClientInterface) {
+      clientModuleDeclaration.addInterface({
+        name: "CreateClient",
+        callSignatures: [
+          {
+            parameters: [
+              {
+                name: "repositoryNameOrEndpoint",
+                type: "string"
+              },
+              {
+                name: "options",
+                type: "prismic.ClientConfig",
+                hasQuestionToken: true
+              }
+            ],
+            returnType: (config.customTypeModels?.length || 0) > 0 ? "prismic.Client<AllDocumentTypes>" : "prismic.Client"
+          }
+        ]
+      });
+    }
+    if (config.clientIntegration.includeContentNamespace) {
+      const contentNamespaceDeclaration = clientModuleDeclaration.addModule({
+        name: "Content",
+        declarationKind: tsMorph.ModuleDeclarationKind.Namespace
+      });
+      const exportSymbols = sourceFile.getExportSymbols().filter((exportSymbol) => {
+        return exportSymbol.getName() !== simplifyTypeAlias.getName();
+      });
+      contentNamespaceDeclaration.addExportDeclaration({
+        isTypeOnly: true,
+        namedExports: exportSymbols.map((exportSymbol) => {
+          return {
+            name: exportSymbol.getName()
+          };
+        })
+      });
+    }
   }
   return getSourceFileText(sourceFile);
 };