agrs-sequelize-sdk 1.0.5 → 1.0.6

package/README.md

@@ -1 +1,179 @@
-# agrs-sequelize
+# agrs-sequelize SDK
+
+The `agrs-sequelize` SDK provides a structured way to manage your database models using Sequelize ORM. It allows you to easily add, update, and manage models, with support for publishing updates to NPM and pushing changes to GitHub.
+
+## Table of Contents
+
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Adding or Modifying Models](#adding-or-modifying-models)
+  - [Model Loading](#model-loading)
+- [Publishing Changes](#publishing-changes)
+  - [Using PowerShell (Windows)](#using-powershell-windows)
+  - [Using Bash (Linux/macOS)](#using-bash-linuxmacos)
+- [Script Details](#script-details)
+  - [run.ps1 (PowerShell Script for Windows)](#runps1-powershell-script-for-windows)
+  - [run.sh (Bash Script for Linux/macOS)](#runsh-bash-script-for-linuxmacos)
+- [Example Model File](#example-model-file)
+- [Versioning](#versioning)
+- [Troubleshooting](#troubleshooting)
+- [License](#license)
+
+## Prerequisites
+
+Ensure the following dependencies are installed on your system:
+
+- **Node.js**: [Download Node.js](https://nodejs.org/)
+- **Sequelize**: Used for database interaction.
+- **Git**: Required for version control and publishing changes to GitHub.
+- **npm**: For managing and publishing packages.
+- **PowerShell** (Windows) or **Bash** (Linux/macOS): For running automation scripts.
+
+## Installation
+
+1. **Clone the Repository:**
+
+   ```bash
+   git clone https://github.com/your-repo/agrs-sequelize.git
+   cd agrs-sequelize
+    ```
+
+2. **Install Dependencies:**
+
+   ```bash
+        npm install
+    ```
+
+
+# Usage
+
+## Adding or Modifying Models
+To add or modify models in the agrs-sequelize SDK:
+
+1. **Create or Edit a Model:**
+
+    - Add a new model file inside the models directory or edit an existing one.
+    - Each model file should export a function that initializes the model with Sequelize.
+
+```javascript
+// models/YourModel.js
+module.exports = (sequelize, DataTypes) => {
+  const YourModel = sequelize.define('YourModel', {
+    fieldName: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+  });
+
+  // Define associations (optional)
+  YourModel.associate = (models) => {
+    YourModel.hasMany(models.OtherModel);
+  };
+
+  return YourModel;
+}; 
+```
+
+2. **Define Associations (if required):**
+
+    Use the associate method to define relationships with other models.
+    Associations like hasMany, belongsTo, etc., are supported.
+### Model Loading
+    Models are automatically loaded when initializing Sequelize.
+    The index.js file ensures all models in the models directory are properly loaded and associated.
+
+## Publishing Changes
+ After modifying or adding models, publish the changes to NPM and GitHub.
+
+### Using PowerShell (Windows)
+Open PowerShell as Administrator.
+
+Run the Script:
+
+```powershell
+./run.ps1
+```
+The script will:
+
+- Check for jq installation.
+- Bump the version in package.json.
+- Publish to NPM.
+- Commit and push changes to GitHub.
+
+### Using Bash (Linux/macOS)
+Open a Bash Terminal.
+
+Run the Script:
+
+```bash
+./run.sh
+```
+The script performs the same tasks as the PowerShell script, tailored for Bash environments.
+
+## Script Details
+### run.ps1 (PowerShell Script for Windows)
+Automates the publishing process:
+
+- Ensures jq is installed.
+- Increments the version in package.json.
+- Publishes the package to NPM.
+- Commits and pushes changes to GitHub.
+
+### run.sh (Bash Script for Linux/macOS)
+Provides similar functionality:
+
+- Checks for jq installation.
+- Bumps the package version.
+= Publishes to NPM.
+= Commits and pushes to GitHub.
+
+## Example Model File
+```javascript
+Copy code
+// models/YourModel.js
+module.exports = (sequelize, DataTypes) => {
+  const YourModel = sequelize.define('YourModel', {
+    name: {
+      type: DataTypes.STRING,
+      allowNull: false,
+    },
+  });
+
+  // Define associations (optional)
+  YourModel.associate = (models) => {
+    YourModel.hasMany(models.OtherModel);
+  };
+
+  return YourModel;
+};
+```
+In this example:
+
+YourModel has a name field.
+It has a hasMany association with OtherModel.
+## Versioning
+Versioning is handled automatically:
+
+- The scripts increment the version in package.json.
+- Follows semantic versioning (major, minor, patch).
+- Updated versions are published to NPM and committed to the repository.
+
+## Troubleshooting
+- ### Permission Issues:
+
+   - Linux/macOS: Ensure scripts have execute permissions (chmod +x run.sh).
+- ### NPM Login Errors:
+
+   - The script will prompt for NPM login if not already logged in.
+   - Verify NPM account credentials.
+
+- ### Missing Dependencies:
+
+   - The script checks for jq and installs it if missing.
+## License
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+
+
+

package/package.json

@@ -1 +1 @@
-{"name":"agrs-sequelize-sdk","version":"1.0.5","main":"index.js","scripts":{"start":"node index.js","sync":"node services/sequelizeService.js","test":"echo \"Error: no test specified\" \u0026\u0026 exit 1"},"keywords":[],"author":"","license":"ISC","description":"","dependencies":{"pg":"^8.13.0","pg-hstore":"^2.3.4","sequelize":"^6.37.4"}}
+{"name":"agrs-sequelize-sdk","version":"1.0.6","main":"index.js","scripts":{"start":"node index.js","sync":"node services/sequelizeService.js","test":"echo \"Error: no test specified\" \u0026\u0026 exit 1"},"keywords":[],"author":"","license":"ISC","description":"","dependencies":{"pg":"^8.13.0","pg-hstore":"^2.3.4","sequelize":"^6.37.4"}}

package/run.bat

@@ -1,105 +0,0 @@
-@echo off
-setlocal
-
-:: Check if running as administrator
-net session >nul 2>&1
-if %ERRORLEVEL% neq 0 (
-    echo This script must be run as an administrator.
-    echo Please right-click on the script and select 'Run as Administrator'.
-    pause
-    exit /b 1
-)
-
-:: Check if jq is installed
-where jq >nul 2>nul
-if %ERRORLEVEL% neq 0 (
-    echo jq not found. Downloading jq manually...
-    powershell -Command "Invoke-WebRequest -Uri https://github.com/stedolan/jq/releases/download/jq-1.6/jq-win64.exe -OutFile %TEMP%\jq.exe"
-    if exist %TEMP%\jq.exe (
-        move /y %TEMP%\jq.exe %SystemRoot%\System32\jq.exe >nul
-        if %ERRORLEVEL% neq 0 (
-            echo Failed to move jq to System32. Please run this script as administrator.
-            exit /b 1
-        )
-        echo jq installed manually.
-    ) else (
-        echo Failed to download jq. Please install it manually.
-        exit /b 1
-    )
-)
-
-:: Step 1: Check if already logged in to NPM
-npm whoami >nul 2>nul
-if %ERRORLEVEL% neq 0 (
-    echo Not logged in. Logging in to NPM...
-    npm login
-    if %ERRORLEVEL% neq 0 (
-        echo NPM login failed. Exiting...
-        exit /b 1
-    )
-) else (
-    for /f %%i in ('npm whoami') do set USERNAME=%%i
-    echo Already logged in to NPM as %USERNAME%
-)
-
-:: Step 2: Increment version in package.json
-for /f "tokens=*" %%i in ('jq -r ".version" package.json') do set current_version=%%i
-
-if "%current_version%"=="" (
-    echo Could not find version in package.json
-    exit /b 1
-)
-
-:: Split version into major, minor, patch
-for /f "tokens=1-3 delims=." %%a in ("%current_version%") do (
-    set major=%%a
-    set minor=%%b
-    set patch=%%c
-)
-
-:: Increment version numbers with three-digit logic
-if "%patch%"=="99" (
-    set patch=0
-    if "%minor%"=="99" (
-        set minor=0
-        set /a major+=1
-    ) else (
-        set /a minor+=1
-    )
-) else (
-    set /a patch+=1
-)
-
-set new_version=%major%.%minor%.%patch%
-
-:: Update the version in package.json using jq
-jq --arg new_version "%new_version%" ".version = $new_version" package.json > temp.json && move /y temp.json package.json
-
-if %ERRORLEVEL% neq 0 (
-    echo Failed to update package.json. Exiting...
-    exit /b 1
-)
-
-echo Version updated from %current_version% to %new_version%
-
-:: Step 3: Publish the package to NPM
-npm publish
-if %ERRORLEVEL% neq 0 (
-    echo NPM publish failed. Exiting...
-    exit /b 1
-)
-
-:: Step 4: Commit the changes and push to GitHub
-git add .
-git commit -m "Bump version to %new_version%"
-git push origin %cd:~2,100%
-
-if %ERRORLEVEL% neq 0 (
-    echo Failed to push changes to GitHub. Exiting...
-    exit /b 1
-)
-
-echo Version %new_version% published and changes pushed to GitHub successfully!
-
-endlocal
-exit /b 0