motia 0.0.32 → 0.0.34

package/README.md

@@ -1,18 +1,91 @@
-# Motia Snap
+# Motia
 
-Motia Snap is a command-line interface tool to get your Motia project setup.
+<p align="center">
+  <img src="https://raw.githubusercontent.com/motiajs/motia/main/assets/logo.png" alt="Motia Logo" width="200" />
+</p>
 
-## Installation
+<p align="center">
+  <strong>A modern, declarative workflow framework for multiple programming languages</strong>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/motia"><img src="https://img.shields.io/npm/v/motia.svg" alt="npm version"></a>
+  <a href="https://github.com/motiajs/motia/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="license"></a>
+</p>
+
+## What is Motia?
+
+Motia is a lightweight, flexible framework for building complex workflows and business processes across multiple programming languages. It allows you to define, visualize, and execute workflows with a clean, declarative API in JavaScript, TypeScript, Ruby, Python, and more languages coming soon.
 
-To install the CLI globally, run:
+Key features:
+- 🔄 **Declarative Workflows**: Define complex processes with a simple, readable syntax
+- 🛠️ **Type-Safe**: Built with strong typing support for all supported languages
+- 🔍 **Visualizable**: Inspect and debug your workflows with Motia Workbench
+- 🧩 **Composable**: Build complex workflows from reusable components
+- 🚀 **Multi-Language Support**: Works with JavaScript, TypeScript, Ruby, Python, with more languages coming soon
+- 🌐 **Framework Agnostic**: Integrates with any framework in your language of choice
 
+## Installation
+
+### JavaScript/TypeScript
 ```sh
-npm install -g motia
+npm install motia
+# or
+yarn add motia
+# or
+pnpm add motia
 ```
 
-## Usage
 
-Below are the available commands for the Motia Snap:
+```
+
+## Quick Start
+
+### Email Auto-Reply with Sentiment Analysis
+
+Here's a real-world example of using Motia to create an automated email reply system with sentiment analysis:
+
+```typescript
+import { OpenAI } from 'openai';
+import { z } from 'zod';
+import type { EventConfig, StepHandler } from 'motia';
+
+const openai = new OpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+});
+
+export const config: EventConfig = {
+  type: 'event',
+  name: 'Auto-Reply to Support Emails',
+  subscribes: ['email.received'],
+  emits: ['email.send'],
+  flows: ['email-support'],
+  input: z.object({ subject: z.string(), body: z.string(), from: z.string() }),
+};
+
+export const handler: StepHandler<typeof config> = async (inputData, context) => {
+  const { subject, body, from } = inputData;
+  const { emit, logger } = context;
+
+  const sentimentResponse = await openai.chat.completions.create({
+    model: "gpt-4o",
+    messages: [{ role: "user", content: `Analyze the sentiment of the following email: ${body}` }]
+  });
+
+  const sentiment = sentimentResponse.choices[0].message.content;
+  
+  logger.info('[EmailAutoReply] Sentiment analysis', { sentiment });
+  
+  emit({
+    type: 'email.send',
+    data: { from, subject, body, sentiment },
+  });
+};
+```
+
+## CLI Commands
+
+Motia comes with a powerful CLI to help you manage your projects:
 
 ### `motia init`
 
@@ -38,6 +111,26 @@ Initiates a dev environment for your project allowing you to use Motia Workbench
 motia dev
 ```
 
+## Visualizing Workflows
+
+Motia Workbench provides a visual interface to inspect and debug your workflows:
+
+```sh
+motia dev
+```
+
+Then open your browser at `http://localhost:3000` to see your workflows in action.
+
+## Language Support
+
+Motia currently supports:
+- JavaScript
+- TypeScript
+- Ruby
+- Python
+
+With more languages coming soon!
+
 ## Help
 
 For more information on a specific command, you can use the `--help` flag:
@@ -46,6 +139,14 @@ For more information on a specific command, you can use the `--help` flag:
 motia <command> --help
 ```
 
+## Documentation
+
+For full documentation, visit [https://motia.dev/docs](https://motia.dev/docs)
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](https://github.com/motiajs/motia/blob/main/CONTRIBUTING.md) for details.
+
 ## License
 
 This project is licensed under the MIT License.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from '@motiadev/core';
+export * from '@motiadev/workbench';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@motiadev/core"), exports);
+__exportStar(require("@motiadev/workbench"), exports);

package/dist/src/builder/build-printer.d.ts

@@ -0,0 +1,9 @@
+import { Step } from '@motiadev/core/dist/src/types';
+export declare class BuildPrinter {
+    private readonly printer;
+    private readonly output;
+    printStepBuilding(step: Step): void;
+    printStepBuilt(step: Step): void;
+    printStepFailed(step: Step, error: Error): void;
+    printStepSkipped(step: Step, reason: string): void;
+}

package/dist/src/builder/build.d.ts

@@ -0,0 +1 @@
+export declare const build: () => Promise<void>;

package/dist/src/builder/cli-output-manager.d.ts

@@ -0,0 +1,6 @@
+export declare class CLIOutputManager {
+    private lines;
+    private lineCount;
+    logStep(id: string, message: string): void;
+    updateStep(id: string, newMessage: string): void;
+}

package/dist/src/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/src/create/index.d.ts

@@ -0,0 +1,6 @@
+type Args = {
+    projectName: string;
+    template?: string;
+};
+export declare const create: ({ projectName, template }: Args) => Promise<void>;
+export {};

package/dist/src/create/templates/default/generate.d.ts

@@ -0,0 +1,4 @@
+export declare const generateStepFiles: (flowDir: string, files: {
+    [key: string]: string;
+}) => Promise<void>;
+export declare const generateDefaultTemplateSteps: (flowDir: string) => Promise<void>;

package/dist/src/create/templates/index.d.ts

@@ -0,0 +1 @@
+export declare const templates: Record<string, (dir: string) => Promise<void>>;

package/dist/src/create-step/getAnswers.d.ts

@@ -0,0 +1,2 @@
+import { StepAnswers } from './types';
+export declare const getStepAnswers: () => Promise<StepAnswers>;

package/dist/src/create-step/index.d.ts

@@ -0,0 +1,3 @@
+export declare function createStep(options: {
+    stepFilePath?: string;
+}): Promise<void>;

package/dist/src/create-step/teamplateUtils.d.ts

@@ -0,0 +1,5 @@
+import { StepAnswers } from './types';
+/**
+ * Generates the appropriate template based on language and type
+ */
+export declare function generateTemplate(answers: StepAnswers): Promise<string>;

package/dist/src/create-step/templates/ui/overrides.d.ts

@@ -0,0 +1,5 @@
+import { StepAnswers } from '../../types';
+/**
+ * Generates a React component override for the step
+ */
+export declare function generateOverride(answers: StepAnswers): Promise<string>;

package/dist/src/create-step/types.d.ts

@@ -0,0 +1,21 @@
+export declare const STEP_TYPES: readonly ["api", "event", "cron", "noop"];
+export declare const LANGUAGES: readonly ["typescript", "javascript", "python", "ruby"];
+export declare const HTTP_METHODS: readonly ["GET", "POST", "PUT", "DELETE"];
+export type StepType = (typeof STEP_TYPES)[number];
+export type Language = (typeof LANGUAGES)[number];
+export type HttpMethod = (typeof HTTP_METHODS)[number];
+export type StepAnswers = {
+    name: string;
+    language: Language;
+    type: StepType;
+    description?: string;
+    method?: HttpMethod;
+    path?: string;
+    subscriptions?: string[];
+    cronExpression?: string;
+    virtualEmits?: string[];
+    virtualSubscribes?: string[];
+    emits: string[];
+    flows: string[];
+    createOverride: boolean;
+};

package/dist/src/create-step/utils.d.ts

@@ -0,0 +1,2 @@
+import { Language } from './types';
+export declare const getFileExtension: (language: Language) => string;

package/dist/src/dev/state-endpoints.d.ts

@@ -0,0 +1,2 @@
+import { MotiaServer, StateAdapter } from '@motiadev/core';
+export declare const stateEndpoints: (server: MotiaServer, stateAdapter: StateAdapter) => void;

package/dist/src/dev/workflow-config-endpoints.d.ts

@@ -0,0 +1,2 @@
+import { MotiaServer } from '@motiadev/core';
+export declare const workflowConfigEndpoints: (server: MotiaServer, baseDir: string) => void;

package/dist/src/dev-watchers.d.ts

@@ -0,0 +1,3 @@
+import { LockedData, MotiaServer, MotiaEventManager, CronManager } from '@motiadev/core';
+import { Watcher } from './watcher';
+export declare const createDevWatchers: (lockedData: LockedData, server: MotiaServer, eventHandler: MotiaEventManager, cronManager: CronManager) => Watcher;

package/dist/src/dev.d.ts

@@ -0,0 +1 @@
+export declare const dev: (port: number, isVerbose: boolean) => Promise<void>;

package/dist/src/generate-locked-data.d.ts

@@ -0,0 +1,3 @@
+import { LockedData, Step } from '@motiadev/core';
+export declare const collectFlows: (baseDir: string, lockedData: LockedData) => Promise<Step[]>;
+export declare const generateLockedData: (projectDir: string) => Promise<LockedData>;

package/dist/src/watcher.d.ts

@@ -0,0 +1,24 @@
+import { LockedData, Step } from '@motiadev/core';
+type StepChangeHandler = (oldStep: Step, newStep: Step) => void;
+type StepCreateHandler = (step: Step) => void;
+type StepDeleteHandler = (step: Step) => void;
+export declare class Watcher {
+    private readonly dir;
+    private lockedData;
+    private watcher?;
+    private stepChangeHandler?;
+    private stepCreateHandler?;
+    private stepDeleteHandler?;
+    constructor(dir: string, lockedData: LockedData);
+    onStepChange(handler: StepChangeHandler): void;
+    onStepCreate(handler: StepCreateHandler): void;
+    onStepDelete(handler: StepDeleteHandler): void;
+    private findStep;
+    private onFileAdd;
+    private onFileChange;
+    private onFileDelete;
+    init(): void;
+    private isStepFile;
+    stop(): Promise<void>;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "motia",
-  "version": "0.0.32",
+  "version": "0.0.34",
   "license": "MIT",
   "bin": {
     "motia": "dist/src/cli.js"
@@ -16,8 +16,8 @@
     "inquirer": "^12.4.1",
     "ts-node": "^10.9.2",
     "yaml": "^2.7.0",
-    "@motiadev/core": "0.0.32",
-    "@motiadev/workbench": "0.0.32"
+    "@motiadev/core": "0.0.34",
+    "@motiadev/workbench": "0.0.34"
   },
   "devDependencies": {
     "@types/archiver": "^6.0.3",