@shamil-tp/connectdb 0.0.0-stage → 1.0.0

package/LICENSE.md

@@ -0,0 +1,20 @@
+    The MIT License (MIT)
+
+    Copyright (c) 2026 Shamil TP
+
+
+
+    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,3 +1,19 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @shamil-tp/connectdb
+
+[![npm version](https://img.shields.io/npm/v/@shamil-tp/connectdb.svg)](https://www.npmjs.com/package/@shamil-tp/connectdb)
+[![npm downloads](https://img.shields.io/npm/dm/@shamil-tp/connectdb.svg)](https://www.npmjs.com/package/@shamil-tp/connectdb)
+[![license](https://img.shields.io/npm/l/@shamil-tp/connectdb.svg)](https://github.com/shamil-tp/connectDB/blob/main/LICENSE)
+
+A lightweight MongoDB connection utility for Node.js using Mongoose.
+
+## Features
+
+- Zero-configuration MongoDB setup for Mongoose.
+- Fallback to `process.env.MONGO_URI` or local `mongodb://127.0.0.1:27017/my_database`.
+- Supports custom connection URI parameters.
+- Clean error handling for test runners and CLI verification.
+
+## Installation
+
+```bash
+npm install @shamil-tp/connectdb

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "@shamil-tp/connectdb",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "description": "A simple function that sets up MongoDB connection for Mongoose",
+  "main": "src/index.js",
+  "type": "commonjs",
+  "files": [
+    "src/"
+  ],
+  "scripts": {
+    "test": "node --test test/connect.test.js"
+  },
+  "keywords": [
+    "js",
+    "connectdb",
+    "mongoose",
+    "mongodb"
+  ],
+  "author": "shamil-tp",
+  "license": "MIT",
+  "homepage": "https://github.com/shamil-tp/connectDB#readme",
+  "bugs": {
+    "url": "https://github.com/shamil-tp/connectDB/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shamil-tp/connectDB.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "mongoose": "^9.11.4"
+  }
 }

package/src/index.js

@@ -0,0 +1,21 @@
+const mongoose = require('mongoose');
+
+const connectDB = async (customUri) => {
+  try {
+    const uri = customUri || process.env.MONGO_URI || 'mongodb://127.0.0.1:27017/my_database';
+    const conn = await mongoose.connect(uri);
+    console.log(`MongoDB Connected: ${conn.connection.host}`);
+    return conn;
+  } catch (error) {
+    console.error(`Database Connection Error: ${error.message}`);
+    
+    // If called directly via CLI/tests, throw error so node:test catches it
+    if (process.env.NODE_ENV === 'test') {
+      throw error;
+    }
+    
+    process.exit(1);
+  }
+};
+
+module.exports = connectDB;