@wipperoz/common-entities-account 1.0.1

package/README.md

@@ -0,0 +1,2 @@
+# common-entities-account
+Common repository for account entities

package/dist/src/enums/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./measurementSystem.enum"), exports);
+__exportStar(require("./notificationMeansType.enum"), exports);
+__exportStar(require("./notificationType.enum"), exports);

package/dist/src/enums/measurementSystem.enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.measurementSystemEnum = exports.MeasurementSystemEnum = void 0;
+var MeasurementSystemEnum;
+(function (MeasurementSystemEnum) {
+    MeasurementSystemEnum["IMPERIAL"] = "Imperial";
+    MeasurementSystemEnum["METRIC"] = "Metric";
+})(MeasurementSystemEnum || (exports.MeasurementSystemEnum = MeasurementSystemEnum = {}));
+exports.measurementSystemEnum = Object.values(MeasurementSystemEnum);

package/dist/src/enums/measurementSystem.enum.test.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const measurementSystem_enum_1 = require("./measurementSystem.enum");
+describe('MeasurementSystemEnum', () => {
+    it('should have IMPERIAL and METRIC values', () => {
+        expect(measurementSystem_enum_1.MeasurementSystemEnum.IMPERIAL).toBe('Imperial');
+        expect(measurementSystem_enum_1.MeasurementSystemEnum.METRIC).toBe('Metric');
+    });
+    it('should have an array of enum values', () => {
+        expect(measurementSystem_enum_1.measurementSystemEnum).toEqual(['Imperial', 'Metric']);
+    });
+});

package/dist/src/enums/notificatioMeansType.enum.test.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const notificationMeansType_enum_1 = require("./notificationMeansType.enum");
+describe('NotificationMeansTypeEnum', () => {
+    it('should have EMAIL and SMS values', () => {
+        expect(notificationMeansType_enum_1.NotificationMeansTypeEnum.EMAIL).toBe('Email');
+        expect(notificationMeansType_enum_1.NotificationMeansTypeEnum.SMS).toBe('SMS');
+    });
+    it('should have an array of enum values', () => {
+        expect(notificationMeansType_enum_1.notificationMeansTypeEnum).toEqual(['Email', 'SMS']);
+    });
+});

package/dist/src/enums/notificationMeansType.enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.notificationMeansTypeEnum = exports.NotificationMeansTypeEnum = void 0;
+var NotificationMeansTypeEnum;
+(function (NotificationMeansTypeEnum) {
+    NotificationMeansTypeEnum["EMAIL"] = "Email";
+    NotificationMeansTypeEnum["SMS"] = "SMS";
+})(NotificationMeansTypeEnum || (exports.NotificationMeansTypeEnum = NotificationMeansTypeEnum = {}));
+exports.notificationMeansTypeEnum = Object.values(NotificationMeansTypeEnum);

package/dist/src/enums/notificationType.enum.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.notificationTypeEnum = exports.NotificationTypeEnum = void 0;
+var NotificationTypeEnum;
+(function (NotificationTypeEnum) {
+    NotificationTypeEnum["BILLING"] = "Billing";
+    NotificationTypeEnum["WIP_TRANSACTIONS"] = "WIP Transactions";
+    NotificationTypeEnum["MARKETING"] = "Marketing";
+})(NotificationTypeEnum || (exports.NotificationTypeEnum = NotificationTypeEnum = {}));
+exports.notificationTypeEnum = Object.values(NotificationTypeEnum);

package/dist/src/enums/notificationType.enum.test.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const notificationType_enum_1 = require("./notificationType.enum");
+describe('NotificationTypeEnum', () => {
+    it('should have BILLING, WIP_TRANSACTIONS, and MARKETING values', () => {
+        expect(notificationType_enum_1.NotificationTypeEnum.BILLING).toBe('Billing');
+        expect(notificationType_enum_1.NotificationTypeEnum.WIP_TRANSACTIONS).toBe('WIP Transactions');
+        expect(notificationType_enum_1.NotificationTypeEnum.MARKETING).toBe('Marketing');
+    });
+    it('should have an array of enum values', () => {
+        expect(notificationType_enum_1.notificationTypeEnum).toEqual([
+            'Billing',
+            'WIP Transactions',
+            'Marketing',
+        ]);
+    });
+    it('should contain all enum keys', () => {
+        const keys = Object.keys(notificationType_enum_1.NotificationTypeEnum);
+        expect(keys).toContain('BILLING');
+        expect(keys).toContain('WIP_TRANSACTIONS');
+        expect(keys).toContain('MARKETING');
+    });
+    it('should contain all enum values', () => {
+        const values = Object.values(notificationType_enum_1.NotificationTypeEnum);
+        expect(values).toContain('Billing');
+        expect(values).toContain('WIP Transactions');
+        expect(values).toContain('Marketing');
+    });
+});

package/dist/src/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./enums"), exports);
+__exportStar(require("./interfaces"), exports);

package/dist/src/interfaces/account-settings.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/interfaces/account-settings.interface.test.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../enums/index.js");
+describe('IAccountSettings Interface', () => {
+    it('should allow an empty Items array', () => {
+        const accountSettings = {};
+        expect(accountSettings.Items).toBeUndefined();
+    });
+    it('should allow Items with Pkey, Skey, and Details', () => {
+        const notification = {
+            notificationType: index_js_1.NotificationTypeEnum.BILLING,
+            allowChange: true,
+            notificationActive: true,
+        };
+        const accountSettings = {
+            Items: [
+                {
+                    Pkey: 'user-id:123',
+                    Skey: 'account-settings-id:456',
+                    Details: {
+                        wipperozNotifications: [notification],
+                    },
+                },
+            ],
+        };
+        expect(accountSettings.Items).toHaveLength(1);
+        expect(accountSettings.Items?.[0].Pkey).toBe('user-id:123');
+        expect(accountSettings.Items?.[0].Skey).toBe('account-settings-id:456');
+        expect(accountSettings.Items?.[0].Details?.wipperozNotifications).toHaveLength(1);
+        expect(accountSettings.Items?.[0].Details?.wipperozNotifications[0]).toEqual(notification);
+    });
+    it('should allow Items without Pkey and Skey', () => {
+        const notification = {
+            notificationType: index_js_1.NotificationTypeEnum.BILLING,
+            allowChange: true,
+            notificationActive: true,
+        };
+        const accountSettings = {
+            Items: [
+                {
+                    Details: {
+                        wipperozNotifications: [notification],
+                    },
+                },
+            ],
+        };
+        expect(accountSettings.Items).toHaveLength(1);
+        expect(accountSettings.Items?.[0].Pkey).toBeUndefined();
+        expect(accountSettings.Items?.[0].Skey).toBeUndefined();
+        expect(accountSettings.Items?.[0].Details?.wipperozNotifications).toHaveLength(1);
+        expect(accountSettings.Items?.[0].Details?.wipperozNotifications[0]).toEqual(notification);
+    });
+});

package/dist/src/interfaces/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./account-settings.interface.js"), exports);
+__exportStar(require("./wipperoz-notification.interface.js"), exports);

package/dist/src/interfaces/wipperoz-notification.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/interfaces/wipperoz-notification.interface.test.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../enums/index.js");
+describe('IWipperozNotification Interface', () => {
+    it('should create a valid IWipperozNotification object', () => {
+        const notification = {
+            notificationType: index_js_1.NotificationTypeEnum.BILLING,
+            allowChange: true,
+            notificationActive: true,
+        };
+        expect(notification.notificationType).toBe(index_js_1.NotificationTypeEnum.BILLING);
+        expect(notification.allowChange).toBe(true);
+        expect(notification.notificationActive).toBe(true);
+    });
+    it('should allow changing notificationActive property', () => {
+        const notification = {
+            notificationType: index_js_1.NotificationTypeEnum.MARKETING,
+            allowChange: true,
+            notificationActive: false,
+        };
+        notification.notificationActive = true;
+        expect(notification.notificationActive).toBe(true);
+    });
+});

package/package.json

@@ -0,0 +1,197 @@
+{
+  "name": "@wipperoz/common-entities-account",
+  "version": "1.0.1",
+  "description": "Wipperoz common entities account package",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "engines": {
+    "node": ">=18"
+  },
+  "author": "Diego Santana <dsantana@wipperoz.com>",
+  "license": "MIT",
+  "scripts": {
+    "cz": "git-cz",
+    "clean": "node bin/run-clean.mjs dist reports",
+    "build": "yarn clean & yarn tsc",
+    "build:watch": "yarn build --watch",
+    "lint": "yarn prettier:check && yarn eslint:cli",
+    "lint:fix": "yarn eslint:fix && yarn prettier:fix",
+    "prettier:cli": "yarn prettier \"*/**/*.{js,ts}\"",
+    "prettier:check": "yarn prettier:cli --l",
+    "prettier:fix": "yarn prettier:cli --write",
+    "eslint:cli": "yarn eslint --report-unused-disable-directives .",
+    "eslint:fix": "yarn eslint:cli --fix",
+    "pretest": "yarn build",
+    "test": "jest --passWithNoTests --colors --coverage",
+    "posttest": "yarn lint:fix",
+    "semantic-release": "semantic-release -t v\\${version}",
+    "prepack": "yarn build",
+    "prepare": "husky"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wipperoz/common-entities-account.git"
+  },
+  "_moduleAliases": {
+    "enums": "dist/enums",
+    "services": "dist/interfaces"
+  },
+  "bugs": {
+    "url": "https://github.com/wipperoz/common-entities-account/issues"
+  },
+  "homepage": "https://github.com/wipperoz/common-entities-account",
+  "dependencies": {
+    "@wipperoz/common-utils": "^1.16.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "@eslint/js": "^9.10.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@tsconfig/node20": "^20.1.4",
+    "@types/jest": "^29.5.13",
+    "@types/node": "^22.5.4",
+    "@typescript-eslint/eslint-plugin": "^8.6.0",
+    "@typescript-eslint/parser": "^8.6.0",
+    "commitizen": "^4.3.0",
+    "conventional-changelog-conventionalcommits": "^8.0.0",
+    "cross-env": "^7.0.3",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^9.10.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-formatter-junit": "^8.40.0",
+    "eslint-plugin-mocha": "^10.5.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-security": "^3.0.1",
+    "eslint-plugin-you-dont-need-lodash-underscore": "^6.14.0",
+    "husky": "^9.1.6",
+    "jest": "^29.7.0",
+    "jest-junit": "^16.0.0",
+    "json-schema-to-ts": "^3.1.1",
+    "prettier": "^3.3.3",
+    "semantic-release": "^24.1.1",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^9.1.1",
+    "tsconfig-paths": "^4.2.0",
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.2",
+    "typescript-eslint": "^8.6.0"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "release": {
+    "branches": [
+      "+([0-9])?(.{+([0-9]),x}).x",
+      "main",
+      "next",
+      "next-major",
+      {
+        "name": "beta",
+        "prerelease": true
+      },
+      {
+        "name": "alpha",
+        "prerelease": true
+      }
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits"
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "chore",
+                "section": "Others",
+                "hidden": false
+              },
+              {
+                "type": "revert",
+                "section": "Reverts",
+                "hidden": false
+              },
+              {
+                "type": "feat",
+                "section": "Features",
+                "hidden": false
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes",
+                "hidden": false
+              },
+              {
+                "type": "improvement",
+                "section": "Feature Improvements",
+                "hidden": false
+              },
+              {
+                "type": "docs",
+                "section": "Docs",
+                "hidden": false
+              },
+              {
+                "type": "style",
+                "section": "Styling",
+                "hidden": false
+              },
+              {
+                "type": "refactor",
+                "section": "Code Refactoring",
+                "hidden": false
+              },
+              {
+                "type": "perf",
+                "section": "Performance Improvements",
+                "hidden": false
+              },
+              {
+                "type": "test",
+                "section": "Tests",
+                "hidden": false
+              },
+              {
+                "type": "build",
+                "section": "Build System",
+                "hidden": false
+              },
+              {
+                "type": "ci",
+                "section": "CI",
+                "hidden": false
+              }
+            ],
+            "issuePrefixes": [
+              "WIP-"
+            ],
+            "issueUrlFormat": "https://wipperoz.atlassian.net/browse/{{prefix}}{{id}}"
+          }
+        }
+      ],
+      [
+        "@semantic-release/changelog",
+        {
+          "changelogFile": "CHANGELOG.md"
+        }
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/git"
+    ]
+  }
+}