agrs-sequelize-sdk 1.0.17 → 1.0.18

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Agressive Scale LTD
-
-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) 2024 Agressive Scale LTD
+
+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,179 +1,179 @@
-# 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.
-
-
-
-
+# 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/config/config.json

@@ -1,24 +1,24 @@
-{
-  "development": {
-    "username": "postgres",
-    "password": "1234",
-    "database": "dev-db",
-    "host": "localhost",
-    "port": 5432,
-    "dialect": "postgres"
-  },
-  "test": {
-    "username": "root",
-    "password": "1234",
-    "database": "test-db",
-    "host": "127:0.0.1",
-    "dialect": "postgres"
-  },
-  "production": {
-    "username": "root",
-    "password": "1234",
-    "database": "prod-db",
-    "host": "127:0.0.1",
-    "dialect": "postgres"
-  }
-}
+{
+  "development": {
+    "username": "postgres",
+    "password": "1234",
+    "database": "dev-db",
+    "host": "localhost",
+    "port": 5432,
+    "dialect": "postgres"
+  },
+  "test": {
+    "username": "root",
+    "password": "1234",
+    "database": "test-db",
+    "host": "127:0.0.1",
+    "dialect": "postgres"
+  },
+  "production": {
+    "username": "root",
+    "password": "1234",
+    "database": "prod-db",
+    "host": "127:0.0.1",
+    "dialect": "postgres"
+  }
+}

package/index.js

@@ -1,75 +1,75 @@
-const Sequelize = require("sequelize");
-const path = require("path");
-const fs = require("fs");
-
-// const env = process.env.NODE_ENV || "development";
-class DBModels {
-  constructor(config) {
-    this.config = config;
-    this.db = {};
-
-    // Initialize Sequelize
-    const sequelize = new Sequelize(
-      this.config.database,
-      this.config.username,
-      this.config.password,
-      {
-        host: this.config.host,
-        dialect: this.config.dialect,
-        port: this.config.port,
-        logging: false,
-        dialectOptions: {
-          ssl: {
-            require: true, // Require SSL
-            rejectUnauthorized: false, // For self-signed or unverified certificates
-          },
-        },
-        pool: {
-          max: 100,
-          min: 0,
-          acquire: 30000,
-          idle: 10000,
-        },
-      }
-    );
-    
-    // // Initialize PaperTrail
-    // const PaperTrail = require("sequelize-paper-trail").init(sequelize, {
-    //   userModel: false, // Optional: set this to true if you have a user model to track who made the changes
-    //   enableRevisionChangeModel: true, // Optional: set this to true if you want to store the changes made to each revision
-    // });
-    // PaperTrail.defineModels(); // Define the Revision and RevisionChange models
-    
-    // Load all models
-    fs.readdirSync(path.join(__dirname, "models"))
-      .filter((file) => {
-        return file.indexOf(".") !== 0 && file.slice(-3) === ".js";
-      })
-      .forEach((file) => {
-        const model = require(path.join(__dirname, "models", file))(
-          sequelize,
-          Sequelize.DataTypes
-        );
-        this.db[model.name] = model;
-      });
-    
-    // Apply PaperTrail to CodefuelCampaign model
-    // const CodefuelCampaign = db["CodefuelCampaign"];
-    // if (CodefuelCampaign) {
-    //   CodefuelCampaign.Revisions = CodefuelCampaign.hasPaperTrail();
-    // }
-    
-    // Set up associations
-    Object.keys(this.db).forEach((modelName) => {
-      if (this.db[modelName].associate) {
-        this.db[modelName].associate(this.db);
-      }
-    });
-    
-    // Export the db object with Sequelize and models
-    this.db.sequelize = sequelize;
-    this.db.Sequelize = Sequelize;
-  }
-}
-
-module.exports = DBModels;
+const Sequelize = require("sequelize");
+const path = require("path");
+const fs = require("fs");
+
+// const env = process.env.NODE_ENV || "development";
+class DBModels {
+  constructor(config) {
+    this.config = config;
+    this.db = {};
+
+    // Initialize Sequelize
+    const sequelize = new Sequelize(
+      this.config.database,
+      this.config.username,
+      this.config.password,
+      {
+        host: this.config.host,
+        dialect: this.config.dialect,
+        port: this.config.port,
+        logging: false,
+        dialectOptions: {
+          ssl: {
+            require: true, // Require SSL
+            rejectUnauthorized: false, // For self-signed or unverified certificates
+          },
+        },
+        pool: {
+          max: 100,
+          min: 0,
+          acquire: 30000,
+          idle: 10000,
+        },
+      }
+    );
+    
+    // // Initialize PaperTrail
+    // const PaperTrail = require("sequelize-paper-trail").init(sequelize, {
+    //   userModel: false, // Optional: set this to true if you have a user model to track who made the changes
+    //   enableRevisionChangeModel: true, // Optional: set this to true if you want to store the changes made to each revision
+    // });
+    // PaperTrail.defineModels(); // Define the Revision and RevisionChange models
+    
+    // Load all models
+    fs.readdirSync(path.join(__dirname, "models"))
+      .filter((file) => {
+        return file.indexOf(".") !== 0 && file.slice(-3) === ".js";
+      })
+      .forEach((file) => {
+        const model = require(path.join(__dirname, "models", file))(
+          sequelize,
+          Sequelize.DataTypes
+        );
+        this.db[model.name] = model;
+      });
+    
+    // Apply PaperTrail to CodefuelCampaign model
+    // const CodefuelCampaign = db["CodefuelCampaign"];
+    // if (CodefuelCampaign) {
+    //   CodefuelCampaign.Revisions = CodefuelCampaign.hasPaperTrail();
+    // }
+    
+    // Set up associations
+    Object.keys(this.db).forEach((modelName) => {
+      if (this.db[modelName].associate) {
+        this.db[modelName].associate(this.db);
+      }
+    });
+    
+    // Export the db object with Sequelize and models
+    this.db.sequelize = sequelize;
+    this.db.Sequelize = Sequelize;
+  }
+}
+
+module.exports = DBModels;