onSuccess callback + prerelease

Author: schickling

packages/@contentlayer/cli/package.json

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

packages/@contentlayer/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentlayer/client",
-  "version": "0.3.2",
+  "version": "0.3.3-dev.1",
   "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.3.2",
+  "version": "0.3.3-dev.1",
   "type": "module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",

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

@@ -56,3 +56,9 @@ export type SourceProvideSchemaErrorJSON = ReturnType<SourceProvideSchemaError['
 export class HandledFetchDataError extends Tagged('HandledFetchDataError')<{}> {}
 
 export class EsbuildBinNotFoundError extends Tagged('EsbuildBinNotFoundError')<{}> {}
+
+export class SuccessCallbackError extends Tagged('SuccessCallbackError')<{
+  readonly error: any
+}> {
+  toString = () => `SuccessCallbackError: ${errorToString(this.error)}`
+}

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

@@ -1,7 +1,7 @@
 import type { AbsolutePosixFilePath, RelativePosixFilePath } from '@contentlayer/utils'
 import { filePathJoin, fs, relative } from '@contentlayer/utils'
 import type { E, HasClock, HasConsole } from '@contentlayer/utils/effect'
-import { Array, Chunk, OT, pipe, S, T } from '@contentlayer/utils/effect'
+import { Array, Chunk, Either, OT, pipe, S, T } from '@contentlayer/utils/effect'
 import type { GetContentlayerVersionError } from '@contentlayer/utils/node'
 import { getContentlayerVersion } from '@contentlayer/utils/node'
 import { camelCase } from 'camel-case'
@@ -12,10 +12,11 @@ import type { HasCwd } from '../cwd.js'
 import { getCwd } from '../cwd.js'
 import type { DataCache } from '../DataCache.js'
 import type { SourceProvideSchemaError } from '../errors.js'
+import { SuccessCallbackError } from '../errors.js'
 import * as esbuild from '../getConfig/esbuild.js'
 import type { Config } from '../getConfig/index.js'
 import type { SourceFetchDataError } from '../index.js'
-import type { PluginOptions, SourcePluginType } from '../plugin.js'
+import type { PluginOptions, SourcePluginType, SuccessCallback } from '../plugin.js'
 import type { DocumentTypeDef, SchemaDef } from '../schema/index.js'
 import { autogeneratedNote, getDataVariableName } from './common.js'
 import { renderTypes } from './generate-types.js'
@@ -42,6 +43,7 @@ type GenerateDotpkgError =
   | SourceFetchDataError
   | esbuild.EsbuildError
   | GetContentlayerVersionError
+  | SuccessCallbackError
 
 export type GenerateInfo = {
   documentCount: number
@@ -105,8 +107,35 @@ export const generateDotpkgStream = ({
             T.eitherMap(() => ({ documentCount: Object.keys(cache.cacheItemsMap).length })),
           ),
         ),
+        S.mapEffect((generateInfo) =>
+          pipe(
+            successCallback(config.source.options.onSuccess),
+            // TODO remove type casting
+            T.fold(
+              (error) => Either.left(error) as typeof generateInfo,
+              () => generateInfo,
+            ),
+          ),
+        ),
+      ),
+    ),
+  )
+}
+
+const successCallback = (onSuccess: SuccessCallback | undefined) => {
+  if (!onSuccess) return T.unit
+
+  return pipe(
+    getCwd,
+    T.map((cwd) => ArtifactsDir.getDirPath({ cwd })),
+    T.tapSync((path) => console.log('successCallback', path)),
+    T.chain((generatedPkgPath) =>
+      T.tryCatchPromise(
+        () => onSuccess(() => import(filePathJoin(generatedPkgPath, 'generated', 'index.mjs'))),
+        (error) => new SuccessCallbackError({ error }),
       ),
     ),
+    OT.withSpan('@contentlayer/core/generation:successCallback'),
   )
 }
 

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

@@ -8,6 +8,7 @@ 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 { GetDataExportsGen } from './gen.js'
 import type { SchemaDef, StackbitExtension } from './schema/index.js'
 
 export type SourcePluginType = LiteralUnion<'local' | 'contentful' | 'sanity', string>
@@ -24,8 +25,11 @@ export type PluginOptions = {
   fieldOptions: FieldOptions
   disableImportAliasWarning: boolean
   experimental: PluginOptionsExperimental
+  onSuccess: SuccessCallback | undefined
 }
 
+export type SuccessCallback = (getData: () => Promise<GetDataExportsGen>) => Promise<void>
+
 export type PluginOptionsExperimental = {
   enableDynamicBuild: boolean
 }
@@ -114,7 +118,6 @@ export type SourcePlugin = {
   type: SourcePluginType
   provideSchema: ProvideSchema
   fetchData: FetchData
-} & {
   options: PluginOptions
   extensions: PluginExtensions
 }
@@ -150,6 +153,7 @@ export type PartialArgs = {
   extensions?: PluginExtensions
   disableImportAliasWarning?: boolean
   experimental?: Partial<PluginOptionsExperimental>
+  onSuccess?: SuccessCallback | undefined
 }
 
 export const defaultFieldOptions: FieldOptions = {
@@ -165,11 +169,27 @@ export const processArgs = async <TArgs extends PartialArgs>(
   options: PluginOptions
   restArgs: Omit<
     TArgs,
-    'extensions' | 'fieldOptions' | 'markdown' | 'mdx' | 'date' | 'disableImportAliasWarning' | 'experimental'
+    | 'extensions'
+    | 'fieldOptions'
+    | 'markdown'
+    | 'mdx'
+    | 'date'
+    | 'disableImportAliasWarning'
+    | 'experimental'
+    | 'onSuccess'
   >
 }> => {
-  const { extensions, fieldOptions, markdown, mdx, date, disableImportAliasWarning, experimental, ...restArgs } =
-    typeof argsOrArgsThunk === 'function' ? await argsOrArgsThunk(sourceKey) : argsOrArgsThunk
+  const {
+    extensions,
+    fieldOptions,
+    markdown,
+    mdx,
+    date,
+    disableImportAliasWarning,
+    experimental,
+    onSuccess,
+    ...restArgs
+  } = typeof argsOrArgsThunk === 'function' ? await argsOrArgsThunk(sourceKey) : argsOrArgsThunk
 
   const options: PluginOptions = {
     markdown,
@@ -183,6 +203,7 @@ export const processArgs = async <TArgs extends PartialArgs>(
     experimental: {
       enableDynamicBuild: experimental?.enableDynamicBuild ?? false,
     },
+    onSuccess,
   }
 
   return { extensions: extensions ?? {}, options, restArgs }

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

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

packages/@contentlayer/source-contentful/package.json

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

packages/@contentlayer/source-files/package.json

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

packages/@contentlayer/source-files/src/__test__/errors/aggregate.spec.ts

@@ -15,6 +15,7 @@ const options: core.PluginOptions = {
   fieldOptions: { typeFieldName, bodyFieldName },
   disableImportAliasWarning: false,
   experimental: { enableDynamicBuild: false },
+  onSuccess: undefined,
 }
 const flags: Flags = {
   onExtraFieldData: 'warn',

packages/@contentlayer/source-files/src/__test__/fetchData/utils.ts

@@ -48,6 +48,7 @@ export const runTest = async ({
       fieldOptions: core.defaultFieldOptions,
       disableImportAliasWarning: false,
       experimental: { enableDynamicBuild: false },
+      onSuccess: undefined,
     }
 
     const cache = yield* $(

packages/@contentlayer/source-files/src/__test__/mapping.spec.ts

@@ -55,6 +55,7 @@ describe('getDataForFieldDef', () => {
           date: undefined,
           disableImportAliasWarning: false,
           experimental: { enableDynamicBuild: false },
+          onSuccess: undefined,
           ...options,
         },
       }),
@@ -140,6 +141,7 @@ test('getDataForFieldDef error', async () => {
             date: undefined,
             disableImportAliasWarning: false,
             experimental: { enableDynamicBuild: false },
+            onSuccess: undefined,
             ...options,
           },
         }),

packages/@contentlayer/source-files/src/__test__/type-generation/basic.spec.ts

@@ -28,6 +28,7 @@ const renderTypeSource = async (documentTypes: DocumentTypes) => {
         date: undefined,
         disableImportAliasWarning: false,
         experimental: { enableDynamicBuild: false },
+        onSuccess: undefined,
       },
     },
   })

packages/@contentlayer/source-files/src/index.ts

@@ -64,6 +64,8 @@ export type Args = {
   contentDirExclude?: string[]
   // NOTE https://github.com/parcel-bundler/watcher/issues/64
 
+  onSuccess?: core.SuccessCallback
+
   /**
    * This is an experimental feature and should be ignored for now.
    */

packages/@contentlayer/source-remote-files/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentlayer/source-remote-files",
-  "version": "0.3.2",
+  "version": "0.3.3-dev.1",
   "type": "module",
   "exports": {
     ".": {

packages/@contentlayer/utils/package.json

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

packages/contentlayer-stackbit-yaml-generator/package.json

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

packages/contentlayer/package.json

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

packages/next-contentlayer/package.json

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