@safagayret/bemirror 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Safa Gayret
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# be.mirror
+
+> **Fake mirror your backend, fast.**
+
+**be.mirror** is an ultra-lightweight, zero-backend, local Node.js API mock server built for frontend teams. It allows you to visualize, create, and interact with complex mock endpoints completely locally without the heavy setup of databases or third-party cloud tools.
+
+## ✨ Features
+
+- **Zero Backend Database:** Everything runs in `localStorage` or in a flat `JSON` file.
+- **Instant Prod URL Mapping:** Effortlessly configure endpoints to a production format.
+- **Live Network Delay Testing:** Set specific request delays (e.g. 500ms) to test your frontend loaders safely.
+- **Strict Parameter & Body Validation:** Expect precise queries or payloads; returns HTTP 400 automatically if not met.
+- **Export / Import Seamlessly:** Share your endpoint configurations with other developers via JSON without hassle. Merge or overwrite local instances.
+- **Code Generator:** Instantly copy valid cURL or JS `fetch()` requests directly from the UI.
+- **Responsive UI:** Works nicely on mobile devices and tablets using an intuitive postman-style flow.
+
+## 🚀 Getting Started
+
+### Prerequisites
+
+Make sure you have Node.js installed (v18+ recommended).
+
+### Installation
+
+Install `bemirror` as a development dependency:
+
+```bash
+npm install --save-dev bemirror
+# or
+pnpm add -D bemirror
+# or
+yarn add -D bemirror
+```
+
+### Run the server
+
+Start the mock server directly with `npx`:
+
+```bash
+npx bemirror
+```
+
+Or add it to your project scripts:
+
+```json
+{
+  "scripts": {
+    "bemirror": "bemirror"
+  }
+}
+```
+
+Then run:
+
+```bash
+npm run bemirror
+```
+
+You can also set a custom port:
+
+```bash
+npx bemirror --port=9000
+```
+
+Once started, open `http://localhost:8000` (or your configured port) to use the UI.
+
+## 🛠 Usage
+
+- Focus on the **Sidebar**: Create a **Project** first, then an **Entity**, and add your mapped **Endpoints**.
+- **Edit your Endpoint:** In the main view, define routing paths, params, and payload rules.
+- **Mock URL Test:** Consume APIs by pointing your React/Vue/Svelte frontend directly to the provided **Mock URL**.
+- **Proxy Test:** Use the built in proxy to make real network requests to external URLs avoiding standard CORS errors in the browser.
+
+## 🤝 Contributing
+
+Contributions are totally welcome! This is an open-source tool aiming at significantly reducing friction during frontend development phases.
+
+1. Fork the repo and create your feature branch (`git checkout -b feature/amazing-feature`)
+2. Commit your changes (`git commit -m 'Added amazing feature'`)
+3. Push to the branch (`git push origin feature/amazing-feature`)
+4. Open a pull request.
+
+## 📄 License
+
+This project is licensed under the MIT License.

package/bin/bemirror

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+const { startBemirrorServer } = require('../index')
+
+const args = process.argv.slice(2)
+const options = {}
+
+for (const arg of args) {
+  if (arg.startsWith('--port=')) {
+    options.port = parseInt(arg.split('=')[1], 10)
+  } else if (arg === '--help' || arg === '-h') {
+    console.log('Usage: bemirror [--port=<port>]')
+    process.exit(0)
+  }
+}
+
+const { server } = startBemirrorServer(options)
+server.on('error', (err) => {
+  console.error('bemirror failed to start:', err.message)
+  process.exit(1)
+})

package/endpoints.json

@@ -0,0 +1,122 @@
+{
+  "projects": [
+    {
+      "id": "p-product-api",
+      "name": "Product API",
+      "entities": [
+        {
+          "id": "e-products",
+          "name": "Products",
+          "endpoints": [
+            {
+              "id": "ep-get-products",
+              "method": "GET",
+              "path": "/products",
+              "statusCode": 200,
+              "delay": 200,
+              "expectedParams": "",
+              "expectedPayload": "",
+              "authorization": {
+                "type": "Basic Auth",
+                "value": "{{username}}:{{password}}"
+              },
+              "headers": [
+                {
+                  "key": "Content-Type",
+                  "value": "application/json"
+                },
+                {
+                  "key": "X-API-Key",
+                  "value": "{{apiKey}}"
+                }
+              ],
+              "responseBody": "{\n  \"products\": [\n    {\n      \"id\": 1,\n      \"name\": \"Laptop\",\n      \"price\": 999.99,\n      \"category\": \"Electronics\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Book\",\n      \"price\": 19.99,\n      \"category\": \"Education\"\n    }\n  ]\n}"
+            },
+            {
+              "id": "ep-post-product",
+              "method": "POST",
+              "path": "/products",
+              "statusCode": 201,
+              "delay": 300,
+              "expectedParams": "",
+              "expectedPayload": "{\n  \"name\": \"string\",\n  \"price\": \"number\",\n  \"category\": \"string\"\n}",
+              "authorization": {
+                "type": "Bearer Token",
+                "value": "{{token}}"
+              },
+              "headers": [
+                {
+                  "key": "Content-Type",
+                  "value": "application/json"
+                }
+              ],
+              "responseBody": "{\n  \"id\": 3,\n  \"name\": \"New Product\",\n  \"price\": 49.99,\n  \"category\": \"Test\",\n  \"createdAt\": \"2024-01-01T00:00:00Z\"\n}"
+            },
+            {
+              "id": "ep-put-product",
+              "method": "PUT",
+              "path": "/products/:id",
+              "statusCode": 200,
+              "delay": 250,
+              "expectedParams": "",
+              "expectedPayload": "{\n  \"name\": \"string\",\n  \"price\": \"number\",\n  \"category\": \"string\"\n}",
+              "authorization": {
+                "type": "Bearer Token",
+                "value": "{{token}}"
+              },
+              "headers": [
+                {
+                  "key": "Content-Type",
+                  "value": "application/json"
+                }
+              ],
+              "responseBody": "{\n  \"id\": 1,\n  \"name\": \"Updated Laptop\",\n  \"price\": 1099.99,\n  \"category\": \"Electronics\",\n  \"updatedAt\": \"2024-01-01T00:00:00Z\"\n}"
+            },
+            {
+              "id": "ep-delete-product",
+              "method": "DELETE",
+              "path": "/products/:id",
+              "statusCode": 204,
+              "delay": 150,
+              "expectedParams": "",
+              "expectedPayload": "",
+              "authorization": {
+                "type": "Bearer Token",
+                "value": "{{token}}"
+              },
+              "headers": [],
+              "responseBody": ""
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "id": "p-jiqoz2ox2",
+      "name": "lorem",
+      "entities": [
+        {
+          "id": "4r96tesww",
+          "name": "ipsum",
+          "endpoints": [
+            {
+              "id": "j4e6t3wui",
+              "method": "GET",
+              "path": "/dolor",
+              "statusCode": 200,
+              "delay": 0,
+              "expectedParams": "",
+              "expectedPayload": "",
+              "responseBody": "{\"success\": true}",
+              "authorization": {
+                "type": "None",
+                "value": ""
+              },
+              "headers": []
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/index.js

@@ -0,0 +1,8 @@
+const { createBemirrorApp, startBemirrorServer } = require('./server')
+
+module.exports = {
+  createBemirrorApp,
+  startBemirrorServer,
+}
+
+module.exports.default = module.exports

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@safagayret/bemirror",
+  "version": "1.0.0",
+  "description": "Fake mirror your backend, fast",
+  "main": "index.js",
+  "bin": {
+    "bemirror": "./bin/bemirror"
+  },
+  "scripts": {
+    "start": "node server.js",
+    "dev": "node server.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "mock",
+    "server",
+    "api",
+    "testing",
+    "development"
+  ],
+  "author": "Safa Gayret",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "index.js",
+    "server.js",
+    "bin/",
+    "public/",
+    "mocks/",
+    "endpoints.json",
+    "variables.json"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gayret/bemirror.git"
+  },
+  "bugs": {
+    "url": "https://github.com/gayret/bemirror/issues"
+  },
+  "homepage": "https://github.com/gayret/bemirror#readme",
+  "dependencies": {
+    "cors": "^2.8.6",
+    "express": "^5.2.1"
+  }
+}