@gettersethya/mira 0.1.0-alpha.2 → 0.1.0-alpha.3

package/README.md

@@ -0,0 +1,103 @@
+# @gettersethya/mira
+
+> **Early pre-alpha.** Breaking changes may occur without notice.
+
+Self-hosted backend in TypeScript using [Effect](https://effect.website). Define collections, get a full REST API with auth, file storage, access rules, and schema migrations — all with zero config.
+
+## Installation
+
+```bash
+npm install @gettersethya/mira @gettersethya/mira-collection effect
+# or
+pnpm add @gettersethya/mira @gettersethya/mira-collection effect
+```
+
+## Quick start
+
+```typescript
+import { LocalFileStorage, Mira, NodePlatform, SqliteDatabase } from "@gettersethya/mira"
+import { Posts, Users } from "./collections.js"
+
+const app = Mira.builder()
+  .platform(NodePlatform)
+  .database(SqliteDatabase({ filename: "mira.db" }))
+  .storage(LocalFileStorage({ directory: "./uploads" }))
+  .collections([Users, Posts])
+  .build()
+
+app.serve({ port: 3000 })
+```
+
+The builder uses phantom types to enforce step ordering — TypeScript will not let you call `.build()` until all four steps are complete.
+
+On first boot, Mira auto-generates a `jwt_secret`, runs schema migrations, and creates SQL views for view collections. Everything is persisted in the database.
+
+## Builder steps
+
+| Step | Required | Description |
+|---|---|---|
+| `.platform(p)` | Yes | Runtime environment (Node.js, etc.) |
+| `.database(d)` | Yes | Database backend |
+| `.storage(s)` | Yes | File storage backend |
+| `.collections(c)` | Yes | Collection definitions |
+| `.telemetry(layer)` | No | Custom Effect telemetry layer |
+| `.extend(layer)` | No | Inject additional layers before serving |
+
+## Platforms
+
+```typescript
+import { NodePlatform } from "@gettersethya/mira"
+
+// Provides: CryptoService, FileSystem, HttpServerFactory, AuthService
+```
+
+## Databases
+
+```typescript
+import { SqliteDatabase } from "@gettersethya/mira"
+
+SqliteDatabase({ filename: "mira.db" })
+SqliteDatabase({ filename: ":memory:" })  // in-memory for tests
+```
+
+## Storage
+
+```typescript
+import { LocalFileStorage } from "@gettersethya/mira"
+
+LocalFileStorage({ directory: "./uploads" })
+```
+
+## Auto-generated endpoints
+
+Each collection gets a full set of REST endpoints:
+
+| Method | Path | Description |
+|---|---|---|
+| `GET` | `/api/:collection` | List (filter, sort, cursor, expand, select) |
+| `GET` | `/api/:collection/:id` | Get one |
+| `POST` | `/api/:collection` | Create |
+| `PATCH` | `/api/:collection/:id` | Update |
+| `DELETE` | `/api/:collection/:id` | Delete |
+| `POST` | `/api/:collection/authWithPassword` | Login (auth collections only) |
+| `POST` | `/api/auth/logout` | Logout |
+| `POST` | `/api/files/token` | Request protected file token |
+| `GET` | `/api/files/:collection/:id/:filename` | Serve file |
+
+## Testing with the service layer
+
+Use `.buildServiceLayer()` to get an Effect `Layer` for all services without starting an HTTP server:
+
+```typescript
+import { Effect, Layer } from "effect"
+
+const serviceLayer = app.buildServiceLayer()
+
+const test = Effect.gen(function* () {
+  // inject and use services directly
+}).pipe(Effect.provide(serviceLayer))
+```
+
+## More
+
+See the [Mira root README](https://github.com/gettersethya/mira) for collection definitions, field types, rules, filter DSL, and client usage.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gettersethya/mira",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.3",
   "type": "module",
   "description": "Self-hosted backend in TypeScript using Effect",
   "author": "Getter Sethya",
@@ -22,7 +22,7 @@
     "@effect/sql-sqlite-node": "^0.52.0",
     "jose": "^6.2.3",
     "mime": "^4.0.0",
-    "@gettersethya/mira-client": "0.1.0-alpha.2"
+    "@gettersethya/mira-client": "0.1.0-alpha.3"
   },
   "peerDependencies": {
     "effect": ">=3.21"