WIP stackbit extension

Author: schickling

packages/@contentlayer/cli/package.json

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

packages/@contentlayer/cli/src/commands/PostInstallCommand.ts

@@ -59,7 +59,7 @@ const generateTypes = ({
     }
 
     const { source, esbuildHash } = sourceEither.right
-    const schemaDef = yield* $(source.provideSchema(esbuildHash))
+    const schemaDef = yield* $(source.provideSchema({ esbuildHash }))
 
     if (!indexDtsFileExists) {
       yield* $(fs.writeFile(indexDtsFilePath, core.makeDataTypes({ schemaDef })))

packages/@contentlayer/client/package.json

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

packages/@contentlayer/core/package.json

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

packages/@contentlayer/core/src/extensions.ts

@@ -0,0 +1,16 @@
+declare global {
+  // TODO docs
+  interface ContentlayerExtensions {
+    // [extensionName: string]: {
+    //   root: never
+    //   documentType: never
+    //   nestedType: never
+    //   field: never
+    // }
+  }
+}
+
+export type ExtensionsRoot = { [K in keyof ContentlayerExtensions]: ContentlayerExtensions[K]['root'] }
+export type ExtensionsDocumentType = { [K in keyof ContentlayerExtensions]: ContentlayerExtensions[K]['documentType'] }
+export type ExtensionsNestedType = { [K in keyof ContentlayerExtensions]: ContentlayerExtensions[K]['nestedType'] }
+export type ExtensionsField = { [K in keyof ContentlayerExtensions]: ContentlayerExtensions[K]['field'] }

packages/@contentlayer/core/src/generation/generate-dotpkg.ts

@@ -76,7 +76,7 @@ export const generateDotpkgStream = ({
   const generationOptions = { sourcePluginType: config.source.type, options: config.source.options }
   const resolveParams = pipe(
     T.structPar({
-      schemaDef: config.source.provideSchema(config.esbuildHash),
+      schemaDef: config.source.provideSchema({ esbuildHash: config.esbuildHash }),
       targetPath: ArtifactsDir.mkdir,
     }),
     T.either,

packages/@contentlayer/core/src/generation/generate-types.ts

@@ -119,7 +119,7 @@ export const renderDocumentTypeDefOrNestedTypeDef = ({
   const computedFields = (def._tag === 'DocumentTypeDef' ? def.computedFields : [])
     .map((field) => `${field.description ? `  /** ${field.description} */\n` : ''}  ${field.name}: ${field.type}`)
     .join('\n')
-  const description = def.description ?? def.extensions.stackbit?.fields?.[def.name]?.label
+  const description = def.description
 
   const rawType = renderRawType({ sourcePluginType })
   const idJsdoc = renderIdJsdoc({ sourcePluginType })

packages/@contentlayer/core/src/index.ts

@@ -3,6 +3,7 @@ export * from './generation/generate-types.js'
 export * from './DataCache.js'
 export * from './data-types.js'
 export * from './cwd.js'
+export * from './extensions.js'
 export * from './gen.js'
 export * from './errors.js'
 export * from './getConfig/index.js'

packages/@contentlayer/core/src/plugin.ts

@@ -7,15 +7,11 @@ import type * as unified from 'unified'
 import type { HasCwd } from './cwd.js'
 import type { DataCache } from './DataCache.js'
 import type { SourceFetchDataError, SourceProvideSchemaError } from './errors.js'
-import type { SchemaDef, StackbitExtension } from './schema/index.js'
+import type { ExtensionsRoot } from './extensions.js'
+import type { SchemaDef } from './schema/index.js'
 
 export type SourcePluginType = LiteralUnion<'local' | 'contentful' | 'sanity', string>
 
-export type PluginExtensions = {
-  // TODO decentralized extension definitions + logic
-  stackbit?: StackbitExtension.Config
-}
-
 export type PluginOptions = {
   markdown: MarkdownOptions | MarkdownUnifiedBuilderCallback | undefined
   mdx: MDXOptions | undefined
@@ -99,12 +95,13 @@ export type SourcePlugin = {
   fetchData: FetchData
 } & {
   options: PluginOptions
-  extensions: PluginExtensions
+  extensions: Partial<ExtensionsRoot>
 }
 
-export type ProvideSchema = (
-  esbuildHash: string,
-) => T.Effect<OT.HasTracer & HasConsole, SourceProvideSchemaError, SchemaDef>
+export type ProvideSchema = (_: {
+  esbuildHash: string
+  extensionProperties?: string[]
+}) => T.Effect<OT.HasTracer & HasConsole, SourceProvideSchemaError, SchemaDef>
 export type FetchData = (_: {
   schemaDef: SchemaDef
   verbose: boolean
@@ -127,7 +124,6 @@ export type PartialArgs = {
   mdx?: MarkdownOptions | undefined
   date?: DateOptions | undefined
   fieldOptions?: Partial<FieldOptions>
-  extensions?: PluginExtensions
   disableImportAliasWarning?: boolean
 }
 
@@ -139,11 +135,10 @@ export const defaultFieldOptions: FieldOptions = {
 export const processArgs = async <TArgs extends PartialArgs>(
   argsOrArgsThunk: TArgs | Thunk<TArgs> | Thunk<Promise<TArgs>>,
 ): Promise<{
-  extensions: PluginExtensions
   options: PluginOptions
-  restArgs: Omit<TArgs, 'extensions' | 'fieldOptions' | 'markdown' | 'mdx' | 'date' | 'disableImportAliasWarning'>
+  restArgs: Omit<TArgs, 'fieldOptions' | 'markdown' | 'mdx' | 'date' | 'disableImportAliasWarning'>
 }> => {
-  const { extensions, fieldOptions, markdown, mdx, date, disableImportAliasWarning, ...restArgs } =
+  const { fieldOptions, markdown, mdx, date, disableImportAliasWarning, ...restArgs } =
     typeof argsOrArgsThunk === 'function' ? await argsOrArgsThunk() : argsOrArgsThunk
 
   const options: PluginOptions = {
@@ -157,5 +152,5 @@ export const processArgs = async <TArgs extends PartialArgs>(
     disableImportAliasWarning: disableImportAliasWarning ?? false,
   }
 
-  return { extensions: extensions ?? {}, options, restArgs }
+  return { options, restArgs }
 }

packages/@contentlayer/core/src/schema/field.ts

@@ -1,3 +1,4 @@
+import type { ExtensionsField } from '../extensions.js'
 import type { NestedUnnamedTypeDef } from './index.js'
 
 export type FieldDefType = FieldDef['type']
@@ -36,6 +37,7 @@ export interface FieldDefBase {
   isRequired: boolean
 
   isSystemField: boolean
+  extensions: Partial<ExtensionsField>
 }
 
 export interface ListFieldDef extends FieldDefBase {