feat: enhance core functionality with new MotiaPluginContext and API endpoints integration (#837)

Author: andersonleal

packages/core/index.ts

@@ -12,7 +12,9 @@ export { StateAdapter } from './src/state/state-adapter'
 export { createMermaidGenerator } from './src/mermaid-generator'
 export { StreamConfig, MotiaStream } from './src/types-stream'
 export { getProjectIdentifier, getUserIdentifier, isAnalyticsEnabled, trackEvent } from './src/analytics/utils'
-export { Motia } from './src/motia'
+export { Motia, MotiaPluginContext } from './src/motia'
 export { NoPrinter, Printer } from './src/printer'
 export { NoTracer } from './src/observability/no-tracer'
 export { config } from './src/config'
+export * from './src/types/schema.types'
+export { StreamAdapter } from './src/streams/adapters/stream-adapter'

packages/core/src/endpoints/api-endpoints.ts

@@ -1,10 +1,10 @@
-import { Printer } from './printer'
-import { TracerFactory } from './observability'
-import { EventManager, InternalStateManager } from './types'
+import type { Express } from 'express'
 import { LockedData } from './locked-data'
 import { LoggerFactory } from './logger-factory'
-import type { Express } from 'express'
+import { TracerFactory } from './observability'
+import { Printer } from './printer'
 import { StateAdapter } from './state/state-adapter'
+import { EventManager, InternalStateManager } from './types'
 
 export type Motia = {
   loggerFactory: LoggerFactory
@@ -17,3 +17,9 @@ export type Motia = {
   app: Express
   stateAdapter: StateAdapter
 }
+
+export type MotiaPluginContext = {
+  app: Express
+  state: StateAdapter
+  lockedData: LockedData
+}

packages/core/src/motia.ts

@@ -6,7 +6,6 @@ import { trackEvent } from './analytics/utils'
 import { callStepFile } from './call-step-file'
 import { CronManager, setupCronHandlers } from './cron-handler'
 import { analyticsEndpoint } from './endpoints/analytics-endpoint'
-import { apiEndpoints } from './endpoints/api-endpoints'
 import { flowsConfigEndpoint } from './endpoints/flows-config-endpoint'
 import { flowsEndpoint } from './endpoints/flows-endpoint'
 import { stepEndpoint } from './endpoints/step-endpoint'
@@ -285,7 +284,6 @@ export const createServer = (
 
   app.use(router)
 
-  apiEndpoints(lockedData)
   flowsEndpoint(lockedData)
   flowsConfigEndpoint(app, process.cwd(), lockedData)
   analyticsEndpoint(app, process.cwd())

packages/core/src/server.ts

@@ -1,11 +1,4 @@
-import { Motia } from '../motia'
-
-export type Runtime = {
-  steps: string
-  streams: string
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  runtime: any
-}
+import { MotiaPluginContext } from '../motia'
 
 export type WorkbenchPlugin = {
   packageName: string
@@ -22,9 +15,8 @@ export type MotiaPlugin = {
   workbench: WorkbenchPlugin[]
 }
 
-export type MotiaPluginBuilder = (motia: Motia) => MotiaPlugin
+export type MotiaPluginBuilder = (motia: MotiaPluginContext) => MotiaPlugin
 
 export type Config = {
-  runtimes?: Runtime[]
   plugins?: MotiaPluginBuilder[]
 }

packages/core/src/types/app-config-types.ts

@@ -13,7 +13,8 @@
     "rootDir": ".",
     "baseUrl": ".",
     "declaration": true,
-    "jsx": "react-jsx",
+    "declarationMap": true,
+    "jsx": "react-jsx"
   },
   "include": ["**/*.ts", "**/*.js"],
   "exclude": ["node_modules", "dist"]

packages/core/tsconfig.json

@@ -1,4 +1,4 @@
-import { Config, Motia, MotiaPlugin } from '@motiadev/core'
+import { Config, Motia, MotiaPlugin, MotiaPluginContext } from '@motiadev/core'
 import fs from 'fs'
 import { globSync } from 'glob'
 import path from 'path'
@@ -18,8 +18,14 @@ export const generatePlugins = async (motia: Motia): Promise<MotiaPlugin[]> => {
     configFiles = globSync('motia.config.{ts,js}', { absolute: true, cwd: baseDir })
   }
 
+  const context: MotiaPluginContext = {
+    app: motia.app,
+    state: motia.stateAdapter,
+    lockedData: motia.lockedData,
+  }
+
   const appConfig: Config = (await import(configFiles[0])).default
-  const plugins = appConfig.plugins?.flatMap((item) => item(motia)) || []
+  const plugins = appConfig.plugins?.flatMap((item) => item(context)) || []
 
   return plugins
 }

packages/snap/src/generate-plugins.ts

@@ -0,0 +1,48 @@
+import { ApiRouteConfig, ApiRouteMethod, JsonSchema, LockedData, QueryParam, Step, StreamAdapter } from '@motiadev/core'
+
+type ApiEndpoint = {
+  id: string
+  method: ApiRouteMethod
+  path: string
+  description?: string
+  queryParams?: QueryParam[]
+  responseSchema?: JsonSchema
+  bodySchema?: JsonSchema
+  flows?: string[]
+}
+
+export const mapEndpoint = (step: Step<ApiRouteConfig>): ApiEndpoint => {
+  return {
+    id: step.filePath,
+    method: step.config.method,
+    path: step.config.path,
+    description: step.config.description,
+    queryParams: step.config.queryParams,
+    responseSchema: step.config.responseSchema as never as JsonSchema,
+    bodySchema: step.config.bodySchema as never as JsonSchema,
+    flows: step.config.flows,
+  }
+}
+
+export class EndpointsStream extends StreamAdapter<ApiEndpoint> {
+  constructor(private readonly lockedData: LockedData) {
+    super()
+  }
+
+  async get(_groupId: string, id: string): Promise<ApiEndpoint | null> {
+    const endpoint = this.lockedData.apiSteps().find((step) => step.filePath === id)
+    return endpoint ? mapEndpoint(endpoint) : null
+  }
+
+  async delete(id: string): Promise<ApiEndpoint> {
+    return { id } as never
+  }
+
+  async set(_: string, __: string, data: ApiEndpoint): Promise<ApiEndpoint> {
+    return data
+  }
+
+  async getGroup(): Promise<ApiEndpoint[]> {
+    return this.lockedData.apiSteps().map(mapEndpoint)
+  }
+}

plugins/plugin-endpoint/src/api/endpoints-stream.ts

@@ -0,0 +1,55 @@
+import { MotiaPlugin, MotiaPluginContext, Step, isApiStep } from '@motiadev/core'
+import { EndpointsStream, mapEndpoint } from './endpoints-stream'
+
+export function plugin({ lockedData }: MotiaPluginContext): MotiaPlugin {
+  const stream = lockedData.createStream({
+    filePath: '__motia.api-endpoints.ts',
+    hidden: true,
+    config: {
+      name: '__motia.api-endpoints',
+      baseConfig: { storageType: 'custom', factory: () => new EndpointsStream(lockedData) },
+      schema: null as never,
+    },
+  })()
+
+  const apiStepCreated = (step: Step) => {
+    if (isApiStep(step)) {
+      stream.set('default', step.filePath, {
+        id: step.filePath,
+        method: step.config.method,
+        path: step.config.path,
+        description: step.config.description,
+        queryParams: step.config.queryParams,
+      })
+    }
+  }
+
+  const apiStepUpdated = (step: Step) => {
+    if (isApiStep(step)) {
+      stream.set('default', step.filePath, mapEndpoint(step))
+    }
+  }
+
+  const apiStepRemoved = (step: Step) => {
+    if (isApiStep(step)) {
+      stream.delete('default', step.filePath)
+    }
+  }
+
+  lockedData.onStep('step-created', apiStepCreated)
+  lockedData.onStep('step-updated', apiStepUpdated)
+  lockedData.onStep('step-removed', apiStepRemoved)
+
+  return {
+    workbench: [
+      {
+        packageName: '@motiadev/plugin-endpoint',
+        cssImports: ['@motiadev/plugin-endpoint/dist/plugin-endpoint.css'],
+        label: 'Endpoints',
+        position: 'top',
+        componentName: 'EndpointsPage',
+        labelIcon: 'link-2',
+      },
+    ],
+  }
+}

plugins/plugin-endpoint/src/api/index.ts

@@ -1,16 +1,3 @@
-import { Motia, MotiaPlugin } from '@motiadev/core'
+import { plugin } from './api'
 
-export default function plugin(motia: Motia): MotiaPlugin {
-  return {
-    workbench: [
-      {
-        packageName: '@motiadev/plugin-endpoint',
-        cssImports: ['@motiadev/plugin-endpoint/dist/plugin-endpoint.css'],
-        label: 'Endpoints',
-        position: 'top',
-        componentName: 'EndpointsPage',
-        labelIcon: 'link-2',
-      },
-    ],
-  }
-}
+export default plugin