override field types

Author: schickling

Diff for: packages/@contentlayer/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentlayer/cli",
-  "version": "0.2.8-dev.9",
+  "version": "0.2.8-dev.12",
   "type": "module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",

Diff for: packages/@contentlayer/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentlayer/client",
-  "version": "0.2.8-dev.9",
+  "version": "0.2.8-dev.12",
   "type": "module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",

Diff for: packages/@contentlayer/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentlayer/core",
-  "version": "0.2.8-dev.9",
+  "version": "0.2.8-dev.12",
   "type": "module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",

Diff for: packages/@contentlayer/experimental-source-files-stackbit/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentlayer/experimental-source-files-stackbit",
-  "version": "0.2.8-dev.9",
+  "version": "0.2.8-dev.12",
   "type": "module",
   "exports": {
     ".": {

Diff for: packages/@contentlayer/experimental-source-files-stackbit/src/index.ts

@@ -1,24 +1,34 @@
-import type { GetDocumentTypeNamesGen } from '@contentlayer/core'
+import type * as core from '@contentlayer/core'
 import type * as SourceFiles from '@contentlayer/source-files'
-import { defineDocumentType } from '@contentlayer/source-files'
-import { not, partition } from '@contentlayer/utils'
+import { defineDocumentType, defineNestedType } from '@contentlayer/source-files'
+import type { PartialDeep } from '@contentlayer/utils'
+import { mergeDeep, not, partition, pick } from '@contentlayer/utils'
 import * as Stackbit from '@stackbit/sdk'
 import { validateAndNormalizeConfig } from '@stackbit/sdk/dist/config/config-loader.js'
 
 import type { SharedCtx } from './mapping.js'
 import { stackbitDocumentLikeModelToDocumentType, stackbitObjectModelToDocumentType } from './mapping.js'
 
+/** NOTE Overrides are currently not validated - use carefully */
 export type ContentlayerOverrideArgs<TDocumentTypeNames extends string> = {
-  documentTypes: Partial<{
+  documentTypes?: Partial<{
     [TDocumentTypeName in TDocumentTypeNames]: ContentlayerOverrideDocumentType<TDocumentTypeName>
   }>
+  nestedTypes?: Partial<{
+    [TDocumentTypeName in TDocumentTypeNames]: ContentlayerOverrideNestedType
+  }>
 }
 
 export type ContentlayerOverrideDocumentType<TDocumentTypeName extends string> = {
   filePathPattern?: string
+  fields?: { [fieldName: string]: { type: SourceFiles.FieldDefType } }
   computedFields?: SourceFiles.ComputedFields<TDocumentTypeName>
 }
 
+export type ContentlayerOverrideNestedType = {
+  fields?: { [fieldName: string]: { type: SourceFiles.FieldDefType } }
+}
+
 /**
  * @example
  * ```ts
@@ -32,9 +42,9 @@ export type ContentlayerOverrideDocumentType<TDocumentTypeName extends string> =
  * })
  * ```
  */
-export const loadStackbitConfigAsDocumentTypes = <TDocumentTypeNames extends GetDocumentTypeNamesGen>(
+export const loadStackbitConfigAsDocumentTypes = <TDocumentTypeNames extends core.GetDocumentTypeNamesGen>(
   options: Stackbit.ConfigLoaderOptions = { dirPath: '' },
-  overrideArgs: ContentlayerOverrideArgs<TDocumentTypeNames> = { documentTypes: {} },
+  overrideArgs: ContentlayerOverrideArgs<TDocumentTypeNames> = { documentTypes: {}, nestedTypes: {} },
 ): Promise<SourceFiles.DocumentType[]> =>
   Stackbit.loadConfig(options).then((configResult) => {
     if (configResult.errors.length > 0) {
@@ -58,9 +68,9 @@ export const loadStackbitConfigAsDocumentTypes = <TDocumentTypeNames extends Get
  * export default makeSource({ contentDirPath: 'content', documentTypes })
  * ```
  */
-export const stackbitConfigToDocumentTypes = <TDocumentTypeNames extends GetDocumentTypeNamesGen>(
+export const stackbitConfigToDocumentTypes = <TDocumentTypeNames extends core.GetDocumentTypeNamesGen>(
   stackbitConfig: Stackbit.Config | Stackbit.YamlConfig,
-  overrideArgs: ContentlayerOverrideArgs<TDocumentTypeNames> = { documentTypes: {} },
+  overrideArgs: ContentlayerOverrideArgs<TDocumentTypeNames> = { documentTypes: {}, nestedTypes: {} },
 ): SourceFiles.DocumentType[] => {
   const validatedStackbitConfig = validateStackbitConfig(stackbitConfig)
 
@@ -76,15 +86,48 @@ export const stackbitConfigToDocumentTypes = <TDocumentTypeNames extends GetDocu
   objectModels.forEach((model) => {
     const nestedType = stackbitObjectModelToDocumentType(ctx)(model)
     ctx.nestedTypeMap[model.name] = nestedType
+
+    const nestedOverride = (overrideArgs.nestedTypes as any)?.[model.name] as ContentlayerOverrideNestedType | undefined
+    const fields = nestedType.def().fields
+    if (nestedOverride?.fields && fields) {
+      for (const [fieldName, { type }] of Object.entries(nestedOverride.fields)) {
+        const fieldDef = Array.isArray(fields)
+          ? fields.find((fieldDef) => fieldDef.name === fieldName)
+          : fields[fieldName]
+
+        if (fieldDef) {
+          fieldDef.type = type
+        }
+      }
+
+      patchNestedType(nestedType, { fields })
+    }
   })
 
   documentTypes.forEach((documentType) => {
     const documentTypeName = documentType.def().name
     ctx.documentTypeMap[documentTypeName] = documentType
 
-    const documentOverride = (overrideArgs.documentTypes as any)[documentTypeName]
-    if (documentOverride) {
-      patchDocumentType(documentType, documentOverride)
+    const documentOverride = (overrideArgs.documentTypes as any)?.[documentTypeName] as
+      | ContentlayerOverrideDocumentType<string>
+      | undefined
+    if (documentOverride?.filePathPattern !== undefined || documentOverride?.computedFields !== undefined) {
+      patchDocumentType(documentType, pick(documentOverride, ['filePathPattern', 'computedFields']))
+    }
+
+    const fields = documentType.def().fields
+    if (documentOverride?.fields && fields) {
+      for (const [fieldName, { type }] of Object.entries(documentOverride.fields)) {
+        const fieldDef = Array.isArray(fields)
+          ? fields.find((fieldDef) => fieldDef.name === fieldName)
+          : fields[fieldName]
+
+        if (fieldDef) {
+          fieldDef.type = type
+        }
+      }
+
+      patchDocumentType(documentType, { fields })
     }
   })
 
@@ -93,10 +136,15 @@ export const stackbitConfigToDocumentTypes = <TDocumentTypeNames extends GetDocu
 
 const patchDocumentType = (
   documentType: SourceFiles.DocumentType,
-  patch: Partial<SourceFiles.DocumentTypeDef>,
+  patch: PartialDeep<SourceFiles.DocumentTypeDef>,
 ): void => {
   const previousDef = documentType.def()
-  documentType.def = defineDocumentType(() => ({ ...previousDef, ...patch })).def
+  documentType.def = defineDocumentType(() => mergeDeep({ ...previousDef, ...patch })).def
+}
+
+const patchNestedType = (nestedType: SourceFiles.NestedType, patch: PartialDeep<SourceFiles.NestedTypeDef>): void => {
+  const previousDef = nestedType.def()
+  nestedType.def = defineNestedType(() => mergeDeep({ ...previousDef, ...patch })).def
 }
 
 const validateStackbitConfig = (stackbitConfig: Stackbit.Config | Stackbit.YamlConfig): Stackbit.Config => {

Diff for: packages/@contentlayer/source-contentful/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentlayer/source-contentful",
-  "version": "0.2.8-dev.9",
+  "version": "0.2.8-dev.12",
   "type": "module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",

Diff for: packages/@contentlayer/source-files/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentlayer/source-files",
-  "version": "0.2.8-dev.9",
+  "version": "0.2.8-dev.12",
   "type": "module",
   "exports": {
     ".": {

Diff for: packages/@contentlayer/utils/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentlayer/utils",
-  "version": "0.2.8-dev.9",
+  "version": "0.2.8-dev.12",
   "type": "module",
   "exports": {
     "./package.json": {

Diff for: packages/@contentlayer/utils/src/object/index.ts

@@ -10,3 +10,23 @@ export const mapObjectValues = <O_In extends Record<any, any>, V_Out>(
   const mappedEntries = Object.entries(obj).map(([key, val]) => [key, mapValue(key as keyof O_In, val)] as const)
   return Object.fromEntries(mappedEntries) as any
 }
+
+export const mergeDeep = <T extends Record<any, any>>(...objs: T[]): T => {
+  const result = {} as T
+  for (const obj of objs) {
+    for (const [key, val] of Object.entries(obj)) {
+      if (val && typeof val === 'object' && !Array.isArray(val)) {
+        // @ts-expect-error TODO
+        result[key] = mergeDeep(result[key] || {}, val)
+      } else {
+        // @ts-expect-error TODO
+        result[key] = val
+      }
+    }
+  }
+  return result
+}
+
+export type PartialDeep<T> = {
+  [P in keyof T]?: T[P] extends Record<any, any> ? PartialDeep<T[P]> : T[P]
+}

Diff for: packages/@contentlayer/utils/src/object/pick.ts

@@ -5,7 +5,10 @@ type ConvertPick<T> = ConvertUndefined<T> & PickRequired<T>
 
 export const pick = <Obj, Keys extends keyof Obj>(obj: Obj, keys: Keys[]): ConvertPick<{ [K in Keys]: Obj[K] }> => {
   return keys.reduce((acc, key) => {
-    acc[key] = obj[key]
+    const val = obj[key]
+    if (val !== undefined) {
+      acc[key] = val
+    }
     return acc
   }, {} as any)
 }

Diff for: packages/contentlayer-stackbit-yaml-generator/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentlayer-stackbit-yaml-generator",
-  "version": "0.2.8-dev.9",
+  "version": "0.2.8-dev.12",
   "type": "module",
   "bin": "./dist/cli/index.js",
   "exports": "./dist/lib/index.js",

Diff for: packages/contentlayer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentlayer",
-  "version": "0.2.8-dev.9",
+  "version": "0.2.8-dev.12",
   "bin": "./bin/cli.cjs",
   "type": "module",
   "engines": {

Diff for: packages/next-contentlayer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-contentlayer",
-  "version": "0.2.8-dev.9",
+  "version": "0.2.8-dev.12",
   "type": "module",
   "main": "./dist/index-cjs.cjs",
   "sideEffects": false,