miqro.js 0.1.0 → 0.1.2

package/README.md

@@ -7,22 +7,23 @@ Designed to process webhooks and run scheduled cron jobs utilizing file-based wo
 
 Create a new project automatically in your current directory:
 ```bash
-bunx miqro init
+bunx miqro.js init
+bun add miqro.js
 ```
 
-This creates a `miqro.config.ts` and a `workflows/` directory.
+This creates a `miqro.config.ts`, a `workflows/` directory, a basic `package.json`, and a `tsconfig.json`.
 
 Start the development server with hot-reloading:
 ```bash
-bunx miqro dev
+bun run dev
 ```
 
 ## Commands
 
-- `miqro init`: Scaffolds `miqro.config.ts` and a `workflows/` directory.
-- `miqro dev`: Starts the engine in development mode with hot-reloading (`bun --watch`).
-- `miqro start`: Starts the engine dynamically for production.
-- `miqro build`: Compiles your project and workflows into a single standalone file at `./dist/index.js`.
+- `miqro.js init` (or `miqro init`): Scaffolds `miqro.config.ts` and a `workflows/` directory.
+- `miqro.js dev`: Starts the engine in development mode with hot-reloading (`bun --watch`).
+- `miqro.js start`: Starts the engine dynamically for production.
+- `miqro.js build`: Compiles your project and workflows into a single standalone file at `./dist/index.js`.
 
 ## Configuration
 
@@ -45,7 +46,7 @@ Miqro automatically discovers `.ts` or `.js` module exports and registers them.
 
 ### Webhook Workflow
 
-Webhooks respond to `POST /webhook?workflowId={id}`. Authentication supports `none`, `apiKey`, or `bearer`.
+Webhooks respond to `POST /{id}`. Authentication supports `none`, `apiKey`, or `bearer`.
 
 ```typescript
 // workflows/example-webhook.ts

package/dist/cli.d.ts

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

package/dist/cli.js

@@ -2974,10 +2974,10 @@ async function startMiqroCore(config, staticWorkflows) {
     uptime: process.uptime(),
     loadedWorkflows: Object.keys(workflows).length
   }));
-  app.post("/webhook", async (c) => {
+  app.post("/:workflowId", async (c) => {
     try {
       const payload = await c.req.json();
-      const workflowId = c.req.query("workflowId") || payload.workflowId;
+      const workflowId = c.req.param("workflowId");
       if (workflowId) {
         const workflow = workflows[workflowId];
         if (!workflow) {
@@ -3014,7 +3014,7 @@ async function startMiqroCore(config, staticWorkflows) {
   console.log(`\uD83D\uDE80 Miqro started on http://localhost:${port}`);
   if (Object.keys(workflows).length > 0) {
     console.log(`Active Webhooks: 
-${Object.keys(workflows).map((w) => ` - POST http://localhost:${port}/webhook?workflowId=${w}`).join(`
+${Object.keys(workflows).map((w) => ` - POST http://localhost:${port}/${w}`).join(`
 `)}`);
   } else {
     console.log(`No workflows loaded.`);
@@ -3059,8 +3059,59 @@ export default {
     if (!existsSync(workflowsPath)) {
       await mkdir(workflowsPath, { recursive: true });
     }
-    console.log("\u2705 Created miqro.config.ts and workflows directory.");
-    console.log("\uD83D\uDC49 Run `miqro dev` to start the development server.");
+    const sampleWorkflowPath = resolve(workflowsPath, "sample.ts");
+    if (!existsSync(sampleWorkflowPath)) {
+      const sampleWorkflow = `import type { Workflow } from "miqro.js";
+
+export default {
+  config: {
+    id: "hello-world",
+    name: "Hello World Workflow",
+    auth: { type: "none" },
+  },
+  execute: async (payload: any) => {
+    console.log("Hello from Miqro!", payload);
+  },
+} satisfies Workflow;
+`;
+      await writeFile(sampleWorkflowPath, sampleWorkflow);
+    }
+    const pkgPath = resolve(process.cwd(), "package.json");
+    if (!existsSync(pkgPath)) {
+      const pkgContent = {
+        name: "miqro-project",
+        type: "module",
+        scripts: {
+          dev: "miqro dev",
+          start: "miqro start",
+          build: "miqro build"
+        }
+      };
+      await writeFile(pkgPath, JSON.stringify(pkgContent, null, 2));
+    }
+    const tsconfigPath = resolve(process.cwd(), "tsconfig.json");
+    if (!existsSync(tsconfigPath)) {
+      const tsconfigContent = {
+        compilerOptions: {
+          lib: ["ESNext"],
+          module: "esnext",
+          target: "esnext",
+          moduleResolution: "bundler",
+          moduleDetection: "force",
+          allowImportingTsExtensions: true,
+          noEmit: true,
+          strict: true,
+          skipLibCheck: true,
+          allowSyntheticDefaultImports: true
+        }
+      };
+      await writeFile(tsconfigPath, JSON.stringify(tsconfigContent, null, 2));
+    }
+    console.log("\u2705 Created miqro.config.ts and workflows directory with a sample.");
+    console.log(`
+\uD83D\uDC49 Next steps:`);
+    console.log("  1. Run: bun add miqro.js");
+    console.log("  2. Run: bun run dev");
     process.exit(0);
   }
   const configPath = resolve(process.cwd(), "miqro.config.ts");
@@ -3153,8 +3204,19 @@ const staticWorkflowsList = [
       console.log(`\u2705 Build successful! Run it with: bun run dist/${outName}`);
     }
   } else {
-    console.error(`Unknown command: ${command}`);
-    console.error("Available commands: init, dev, start, build");
+    console.error(`\u274C Unknown command: ${command}`);
+    console.error(`
+Usage: miqro <command>
+`);
+    console.error("Available commands:");
+    console.error("  init    - Scaffolds a new project with miqro.config.ts and sample workflow");
+    console.error("  dev     - Starts development server with hot-reloading");
+    console.error("  start   - Starts server in production mode");
+    console.error(`  build   - Compiles project into a standalone executable at ./dist/index.js
+`);
+    console.error("Example:");
+    console.error("  bunx miqro.js init");
+    console.error("  bunx miqro.js dev");
     process.exit(1);
   }
 }

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import type { MiqroConfig, Workflow } from "./types";
+/**
+ * Core initialization logic that takes a pre-loaded array of workflows.
+ * Useful for static bundlers.
+ */
+export declare function startMiqroCore(config: Omit<MiqroConfig, "workflowsDir">, staticWorkflows: Workflow[]): Promise<{
+    port: string | number;
+    fetch: (request: Request, Env?: unknown, executionCtx?: import("hono").ExecutionContext) => Response | Promise<Response>;
+}>;
+/**
+ * Initializes and starts the Miqro application dynamically using a directory.
+ */
+export declare function startMiqro(config: MiqroConfig): Promise<{
+    port: string | number;
+    fetch: (request: Request, Env?: unknown, executionCtx?: import("hono").ExecutionContext) => Response | Promise<Response>;
+}>;
+export type { AuthConfig, Workflow, WorkflowConfig } from "./types";

package/dist/index.js

@@ -2973,10 +2973,10 @@ async function startMiqroCore(config, staticWorkflows) {
     uptime: process.uptime(),
     loadedWorkflows: Object.keys(workflows).length
   }));
-  app.post("/webhook", async (c) => {
+  app.post("/:workflowId", async (c) => {
     try {
       const payload = await c.req.json();
-      const workflowId = c.req.query("workflowId") || payload.workflowId;
+      const workflowId = c.req.param("workflowId");
       if (workflowId) {
         const workflow = workflows[workflowId];
         if (!workflow) {
@@ -3013,7 +3013,7 @@ async function startMiqroCore(config, staticWorkflows) {
   console.log(`\uD83D\uDE80 Miqro started on http://localhost:${port}`);
   if (Object.keys(workflows).length > 0) {
     console.log(`Active Webhooks: 
-${Object.keys(workflows).map((w) => ` - POST http://localhost:${port}/webhook?workflowId=${w}`).join(`
+${Object.keys(workflows).map((w) => ` - POST http://localhost:${port}/${w}`).join(`
 `)}`);
   } else {
     console.log(`No workflows loaded.`);

package/dist/types.d.ts

@@ -0,0 +1,24 @@
+export type AuthConfig = {
+    type: "none";
+} | {
+    type: "apiKey";
+    key: string;
+} | {
+    type: "bearer";
+    token: string;
+};
+export interface WorkflowConfig {
+    id: string;
+    name: string;
+    description?: string;
+    auth: AuthConfig;
+    schedule?: string;
+}
+export interface Workflow {
+    config: WorkflowConfig;
+    execute: (payload: unknown) => Promise<void> | void;
+}
+export interface MiqroConfig {
+    workflowsDir: string;
+    port?: number;
+}

package/package.json

@@ -1,11 +1,12 @@
 {
 	"name": "miqro.js",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"description": "Minimal, high-performance microservice engine.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"bin": {
-		"miqro": "dist/cli.js"
+		"miqro": "dist/cli.js",
+		"miqro.js": "dist/cli.js"
 	},
 	"files": [
 		"dist"