quar 1.4.0 → 1.4.2

package/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.2/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/.github/workflows/publish.yaml

@@ -0,0 +1,50 @@
+name: Publish Package
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  release:
+    if: github.ref == 'refs/heads/main' && github.repository == 'IsmailBinMujeeb/Quar-Studio'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+      actions: write
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          registry-url: https://registry.npmjs.org
+          cache: npm
+
+      - name: Set npm token
+        run: |
+          npm config set //registry.npmjs.org/:_authToken ${{ secrets.NPM_TOKEN }}
+          npm config set provenance true
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Create Release Pull Request or Publish to npm
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          version: npm run changeset version
+          publish: npm run changeset publish
+          createGithubReleases: true
+          commit: "chore(release): version packages"
+          title: "chore(release): version packages"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# quar
+
+## 1.4.2
+
+### Patch Changes
+
+- cfe3e93: update package.json
+
+## 1.4.1
+
+### Patch Changes
+
+- a24e395: update readme for latest updates

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Ismail Bin Mujeeb
-
-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.
+MIT License
+
+Copyright (c) 2025 Ismail Bin Mujeeb
+
+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

@@ -1,95 +1,96 @@
-# Quar Studio – Quick UI for Mongoose Models
-
-<p align="center">
-    <img src="./assets/icon.png" alt="logo" width="200px"/>
-</p>
-
-Instantly spin up a web-based editor for your Mongoose models.
-Built for developers who loves quick database interaction!
-
-## Install & Run
-```bash
-npx quar --model <path-to-model-folder> --db <db-name>
-```
-This will load all Mongoose models from the folder and start a local web UI to Create, view, update, and delete documents.
-
-## What it does
-- Loads your Mongoose models dynamically
-- Connects to your MongoDB database
-- Gives a tabbed UI for each model
-- View nested documents in a tree-style
-- Supports Create, Read, update and delete
-
-## Folder Structure
-Your models folder can contain files like this:
-
-```js
-// ./models/Post.js
-import mongoose from "mongoose"
-
-const postSchema = new mongoose.Schema({
-  title: String,
-  body: String,
-  author: {
-    name: String,
-    age: Number
-  }
-});
-
-export default mongoose.model("Post", postSchema);
-```
-
-## Configuration
-
-1. Install Quar as dev deps
-    ```bash
-    npm i quar --save-dev
-    ```
-
-2. Execute Command
-    ```bash
-    npx quar
-    ```
-
-3. Set Models Folder
-    ```bash
-    npx quar --model <folder-path>
-    ```
-
-4. Set Database Name
-    ```bash
-    npx quar --model <folder-path> --db <db-name>
-    ```
-
-5. Set Database URI `(Optional)`
-    ```bash
-    npx quar --model <folder-path> --db <db-name> --uri <db-uri>
-    ```
-    > ***Note:** By default it will try to connect local mongodb if uri not provided
-
-## Usage Tips
-- Supports nested schemas & subdocuments
-- Clean tabbed navigation per model
-- Auto-refreshes data after updates
-- Keyboard shortcuts support
-
-    | Command | Performs |
-    |---------|----------|
-    | <kbd>ctrl + o</kbd> | Toggles Insert Tab |
-    | <kbd>ctrl + r</kbd> | Refresh Model |
-    | <kbd>ctrl + ></kbd> | Go To Next Page |
-    | <kbd>ctrl + <</kbd> | Go To Previous Page |
-
-
-
-## Dev Notes
-
-- Built for development use
-- Doesn’t expose MONGO_URI publicly
-- Uses Mongoose’s model.schema.tree for schema info
-- Modular and extendable
-
-## Contribute
-Pull requests, suggestions, and ideas are welcome!
-
-***Icon: <a href="https://www.flaticon.com/free-icons/thunder" title="thunder icons">Thunder icons created by Hexagon075 - Flaticon</a>***
+# Quar Studio – Quick UI for Mongoose Models
+
+<p align="center">
+    <img src="./assets/icon.png" alt="logo" width="200px"/>
+</p>
+
+Instantly spin up a web-based editor for your Mongoose models.
+Built for developers who loves quick database interaction!
+
+## Install & Run
+```bash
+npx quar
+```
+It will ask you for model folder path, database name and database URI (optional).
+This will load all Mongoose models from the folder and start a local web UI to Create, view, update, and delete documents.
+
+## What it does
+- Loads your Mongoose models dynamically
+- Connects to your MongoDB database
+- Gives a tabbed UI for each model
+- View nested documents in a tree-style
+- Supports Create, Read, update and delete
+
+## Folder Structure
+Your models folder can contain files like this:
+
+```js
+// ./models/Post.js
+import mongoose from "mongoose"
+
+const postSchema = new mongoose.Schema({
+  title: String,
+  body: String,
+  author: {
+    name: String,
+    age: Number
+  }
+});
+
+export default mongoose.model("Post", postSchema);
+```
+
+## Configuration
+
+1. Install Quar as dev deps
+    ```bash
+    npm i quar --save-dev
+    ```
+
+2. Execute Command
+    ```bash
+    npx quar
+    ```
+
+3. Set Models Folder
+    ```bash
+    npx quar --model <folder-path>
+    ```
+
+4. Set Database Name
+    ```bash
+    npx quar --model <folder-path> --db <db-name>
+    ```
+
+5. Set Database URI `(Optional)`
+    ```bash
+    npx quar --model <folder-path> --db <db-name> --uri <db-uri>
+    ```
+    > ***Note:** By default it will try to connect local mongodb if uri not provided
+
+## Usage Tips
+- Supports nested schemas & subdocuments
+- Clean tabbed navigation per model
+- Auto-refreshes data after updates
+- Keyboard shortcuts support
+
+    | Command | Performs |
+    |---------|----------|
+    | <kbd>ctrl + o</kbd> | Toggles Insert Tab |
+    | <kbd>ctrl + r</kbd> | Refresh Model |
+    | <kbd>ctrl + ></kbd> | Go To Next Page |
+    | <kbd>ctrl + <</kbd> | Go To Previous Page |
+
+
+
+## Dev Notes
+
+- Built for development use
+- Doesn’t expose MONGO_URI publicly
+- Uses Mongoose’s model.schema.tree for schema info
+- Modular and extendable
+
+## Contribute
+Pull requests, suggestions, and ideas are welcome!
+
+***Icon: <a href="https://www.flaticon.com/free-icons/thunder" title="thunder icons">Thunder icons created by Hexagon075 - Flaticon</a>***

package/dummy_models/posts.model.js

@@ -1,52 +1,52 @@
-import mongoose from "mongoose";
-
-const postSchema = new mongoose.Schema(
-    {
-        author: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: "User",
-            required: true,
-        },
-        title: {
-            type: String,
-            required: [true, "Post title is required"],
-            trim: true,
-            maxlength: [120, "Title cannot exceed 120 characters"],
-        },
-        content: {
-            type: String,
-            required: [true, "Post content is required"],
-        },
-        image: {
-            type: String,
-            default: null,
-        },
-        likes: [
-            {
-                type: mongoose.Schema.Types.ObjectId,
-                ref: "User",
-            },
-        ],
-        // comments: [
-        //     {
-        //         user: {
-        //             type: mongoose.Schema.Types.ObjectId,
-        //             ref: "User",
-        //         },
-        //         text: {
-        //             type: String,
-        //             required: true,
-        //         },
-        //         createdAt: {
-        //             type: Date,
-        //             default: Date.now,
-        //         },
-        //     },
-        // ],
-    },
-    {
-        timestamps: true,
-    }
-);
-
-export default mongoose.model("Post", postSchema);
+import mongoose from "mongoose";
+
+const postSchema = new mongoose.Schema(
+    {
+        author: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: "User",
+            required: true,
+        },
+        title: {
+            type: String,
+            required: [true, "Post title is required"],
+            trim: true,
+            maxlength: [120, "Title cannot exceed 120 characters"],
+        },
+        content: {
+            type: String,
+            required: [true, "Post content is required"],
+        },
+        image: {
+            type: String,
+            default: null,
+        },
+        likes: [
+            {
+                type: mongoose.Schema.Types.ObjectId,
+                ref: "User",
+            },
+        ],
+        // comments: [
+        //     {
+        //         user: {
+        //             type: mongoose.Schema.Types.ObjectId,
+        //             ref: "User",
+        //         },
+        //         text: {
+        //             type: String,
+        //             required: true,
+        //         },
+        //         createdAt: {
+        //             type: Date,
+        //             default: Date.now,
+        //         },
+        //     },
+        // ],
+    },
+    {
+        timestamps: true,
+    }
+);
+
+export default mongoose.model("Post", postSchema);

package/dummy_models/user.model.js

@@ -1,44 +1,44 @@
-import mongoose from "mongoose";
-
-const userSchema = new mongoose.Schema(
-    {
-        username: {
-            type: String,
-            required: [true, "Username is required"],
-            unique: true,
-            trim: true,
-            minlength: [3, "Username must be at least 3 characters long"],
-        },
-        email: {
-            type: String,
-            required: [true, "Email is required"],
-            unique: true,
-            lowercase: true,
-            match: [/.+@.+\..+/, "Please enter a valid email address"],
-        },
-        password: {
-            type: String,
-            required: [true, "Password is required"],
-            minlength: [6, "Password must be at least 6 characters long"],
-            select: false,
-        },
-        avatar: {
-            type: String,
-        },
-        bio: {
-            type: String,
-            maxlength: [160, "Bio cannot exceed 160 characters"],
-        },
-        posts: [
-            {
-                type: mongoose.Schema.Types.ObjectId,
-                ref: "Post",
-            },
-        ],
-    },
-    {
-        timestamps: true,
-    }
-);
-
-export default mongoose.model("User", userSchema);
+import mongoose from "mongoose";
+
+const userSchema = new mongoose.Schema(
+    {
+        username: {
+            type: String,
+            required: [true, "Username is required"],
+            unique: true,
+            trim: true,
+            minlength: [3, "Username must be at least 3 characters long"],
+        },
+        email: {
+            type: String,
+            required: [true, "Email is required"],
+            unique: true,
+            lowercase: true,
+            match: [/.+@.+\..+/, "Please enter a valid email address"],
+        },
+        password: {
+            type: String,
+            required: [true, "Password is required"],
+            minlength: [6, "Password must be at least 6 characters long"],
+            select: false,
+        },
+        avatar: {
+            type: String,
+        },
+        bio: {
+            type: String,
+            maxlength: [160, "Bio cannot exceed 160 characters"],
+        },
+        posts: [
+            {
+                type: mongoose.Schema.Types.ObjectId,
+                ref: "Post",
+            },
+        ],
+    },
+    {
+        timestamps: true,
+    }
+);
+
+export default mongoose.model("User", userSchema);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quar",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "This will load all Mongoose models from the folder and start a local web UI to Create, view, update, and delete documents.",
   "main": "index.js",
   "type": "module",
@@ -9,7 +9,11 @@
   },
   "scripts": {
     "start": "node index.js",
-    "dev": "node index.js --model ./dummy_models --db quarDB"
+    "dev": "node index.js --model ./dummy_models --db quarDB",
+    "changeset": "changeset"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "author": "@IsmailBinMujeeb (IsmailBinMujeeb@gmail.com)",
   "license": "MIT",
@@ -29,5 +33,8 @@
   "bugs": {
     "url": "https://github.com/IsmailBinMujeeb/quar-studio/issues"
   },
-  "homepage": "https://github.com/IsmailBinMujeeb/quar-studio#readme"
+  "homepage": "https://github.com/IsmailBinMujeeb/quar-studio#readme",
+  "devDependencies": {
+    "@changesets/cli": "^2.29.8"
+  }
 }