@safagayret/bemirror 1.0.0 → 2.1.0

package/README.md

@@ -25,11 +25,11 @@ Make sure you have Node.js installed (v18+ recommended).
 Install `bemirror` as a development dependency:
 
 ```bash
-npm install --save-dev bemirror
+npm install --save-dev @safagayret/bemirror
 # or
-pnpm add -D bemirror
+pnpm add -D @safagayret/bemirror
 # or
-yarn add -D bemirror
+yarn add -D @safagayret/bemirror
 ```
 
 ### Run the server
@@ -37,7 +37,7 @@ yarn add -D bemirror
 Start the mock server directly with `npx`:
 
 ```bash
-npx bemirror
+npx @safagayret/bemirror
 ```
 
 Or add it to your project scripts:
@@ -45,7 +45,7 @@ Or add it to your project scripts:
 ```json
 {
   "scripts": {
-    "bemirror": "bemirror"
+    "bemirror": "@safagayret/bemirror"
   }
 }
 ```
@@ -53,18 +53,27 @@ Or add it to your project scripts:
 Then run:
 
 ```bash
-npm run bemirror
+npm run @safagayret/bemirror
 ```
 
 You can also set a custom port:
 
 ```bash
-npx bemirror --port=9000
+npx @safagayret/bemirror --port=9000
 ```
 
 Once started, open `http://localhost:8000` (or your configured port) to use the UI.
 
-## 🛠 Usage
+## � Data Storage
+
+Your mock data is stored in JSON files in your project root directory:
+
+- `endpoints.json`: Contains your project, entity, and endpoint configurations
+- `variables.json`: Contains global variables for use in endpoints
+
+These files are automatically created when you add data through the UI. You can commit them to your repository to share mock configurations with your team.
+
+## �🛠 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@safagayret/bemirror",
-  "version": "1.0.0",
+  "version": "2.1.0",
   "description": "Fake mirror your backend, fast",
   "main": "index.js",
   "bin": {
@@ -28,9 +28,7 @@
     "server.js",
     "bin/",
     "public/",
-    "mocks/",
-    "endpoints.json",
-    "variables.json"
+    "mocks/"
   ],
   "repository": {
     "type": "git",

package/server.js

@@ -33,7 +33,10 @@ const loadJsonFile = (filePath, defaultValue) => {
       return JSON.parse(fileContent)
     }
   } catch (err) {
-    console.warn(`Failed to load ${path.basename(filePath)}, starting with default state:`, err.message)
+    console.warn(
+      `Failed to load ${path.basename(filePath)}, starting with default state:`,
+      err.message,
+    )
   }
   return defaultValue
 }
@@ -47,8 +50,8 @@ const saveJsonFile = (filePath, data) => {
 }
 
 const createBemirrorApp = (options = {}) => {
-  const ENDPOINTS_FILE = options.endpointsFile || path.join(__dirname, 'endpoints.json')
-  const VARIABLES_FILE = options.variablesFile || path.join(__dirname, 'variables.json')
+  const ENDPOINTS_FILE = options.endpointsFile || path.join(__dirname, '../..', 'endpoints.json')
+  const VARIABLES_FILE = options.variablesFile || path.join(__dirname, '../..', 'variables.json')
   const PUBLIC_DIR = options.publicDir || path.join(__dirname, 'public')
 
   const app = express()
@@ -229,7 +232,9 @@ const createBemirrorApp = (options = {}) => {
           if (incomingObj[key] === undefined) missingKeys.push(key)
         })
         if (missingKeys.length > 0)
-          return res.status(400).json({ error: 'Validation failed', missing_expected_keys: missingKeys })
+          return res
+            .status(400)
+            .json({ error: 'Validation failed', missing_expected_keys: missingKeys })
       } catch (e) {}
     }
 
@@ -242,14 +247,18 @@ const createBemirrorApp = (options = {}) => {
           if (incomingParams[key] === undefined) missingParams.push(key)
         })
         if (missingParams.length > 0)
-          return res.status(400).json({ error: 'Validation failed', missing_query_parameters: missingParams })
+          return res
+            .status(400)
+            .json({ error: 'Validation failed', missing_query_parameters: missingParams })
       } catch (e) {}
     }
 
     let responseJson = {}
     let isJson = true
     try {
-      responseJson = processedEndpoint.responseBody ? JSON.parse(processedEndpoint.responseBody) : {}
+      responseJson = processedEndpoint.responseBody
+        ? JSON.parse(processedEndpoint.responseBody)
+        : {}
     } catch (e) {
       responseJson = processedEndpoint.responseBody
       isJson = false

package/endpoints.json

@@ -1,122 +0,0 @@
-{
-  "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": []
-            }
-          ]
-        }
-      ]
-    }
-  ]
-}