tt-entities 0.0.1

package/eslint.config.mjs

@@ -0,0 +1,35 @@
+// @ts-check
+import eslint from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['eslint.config.mjs'],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+      sourceType: 'commonjs',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-floating-promises': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'warn',
+      "prettier/prettier": ["error", { endOfLine: "auto" }],
+    },
+  },
+);

package/libs/tatayab-entities-library/src/entities/apikey.entity.ts

@@ -0,0 +1,33 @@
+import { Column, DataType, Model, Table } from 'sequelize-typescript';
+import { Status } from '../utils/enums/status';
+import { VersionType } from '../utils/enums/versiontype';
+import { OsName } from '../utils/enums/osName';
+import { ProductApp } from '../utils/enums/productApp';
+
+@Table
+class ApiKey extends Model {
+  @Column
+  hashedApiKey: string;
+  @Column({ type: DataType.ENUM(...Object.values(OsName)) })
+  system: OsName;
+  @Column({ type: DataType.ENUM(...Object.values(ProductApp)) })
+  appName: ProductApp;
+  @Column
+  appVersion: string;
+  @Column
+  expiryDate: Date;
+  @Column({
+    type: DataType.ENUM(...Object.values(Status)),
+    defaultValue: Status.ACTIVE,
+  })
+  status: Status;
+  @Column
+  isReleased: boolean;
+  @Column({
+    type: DataType.ENUM(...Object.values(VersionType)),
+    defaultValue: VersionType.OPTIONAL,
+  })
+  versionType: VersionType;
+}
+
+export default ApiKey;

package/libs/tatayab-entities-library/src/entities/area.entity.ts

@@ -0,0 +1,24 @@
+import {
+  BelongsTo,
+  Column,
+  ForeignKey,
+  Model,
+  Table,
+} from 'sequelize-typescript';
+import { Country } from './country.entity';
+
+@Table
+export class Area extends Model {
+  @ForeignKey(() => Country)
+  @Column({
+    allowNull: false,
+    validate: { notNull: { msg: 'County Id Required' } },
+  })
+  countryId!: number;
+
+  @Column
+  parentId?: number;
+
+  @BelongsTo(() => Country)
+  country: Country;
+}

package/libs/tatayab-entities-library/src/entities/country.entity.ts

@@ -0,0 +1,15 @@
+import { Column, Model, Table } from 'sequelize-typescript';
+
+@Table
+export class Country extends Model {
+  @Column
+  flagIcon: string;
+  @Column
+  isoCode: string;
+  @Column
+  phoneExt: string;
+  @Column
+  currency: string;
+  @Column
+  exchangeRateToKwd: number;
+}

package/libs/tatayab-entities-library/src/entities/sys.role.entity.ts

@@ -0,0 +1,7 @@
+import { Column, Model, Table } from 'sequelize-typescript';
+
+@Table
+export class SysRole extends Model {
+  @Column
+  name: string;
+}

package/libs/tatayab-entities-library/src/entities/sys.user.entity.ts

@@ -0,0 +1,49 @@
+import {
+  BelongsTo,
+  Column,
+  DataType,
+  ForeignKey,
+  Model,
+  Table,
+} from 'sequelize-typescript';
+import { Status } from '../utils/enums/status';
+import { SysRole } from './sys.role.entity';
+
+@Table
+export class SysUser extends Model {
+  @Column
+  name!: string;
+
+  @Column({ allowNull: false, validate: { unique: true } })
+  username!: string;
+
+  @Column
+  email!: string;
+
+  @Column
+  phoneExt!: string;
+
+  @Column
+  phone!: string;
+
+  @Column
+  password!: string;
+  @Column({
+    type: DataType.ENUM(...Object.values(Status)),
+    defaultValue: Status.ACTIVE,
+  })
+  status?: Status;
+
+  @ForeignKey(() => SysRole)
+  @Column
+  roleId: number;
+
+  @Column
+  profilePicture: string;
+
+  @Column
+  lastLogin: Date;
+
+  @BelongsTo(() => SysRole)
+  role: SysRole;
+}

package/libs/tatayab-entities-library/src/entities/translation.entity.ts

@@ -0,0 +1,17 @@
+import { Column, Model, Table } from 'sequelize-typescript';
+
+@Table
+export class Translation extends Model {
+  @Column
+  text: string;
+  @Column
+  shortDesc?: string;
+  @Column
+  longDesc?: string;
+  @Column
+  locale: string;
+  @Column
+  entityId: string;
+  @Column
+  entityName: string;
+}

package/libs/tatayab-entities-library/src/entities/user.entity.ts

@@ -0,0 +1,85 @@
+import {
+  Model,
+  Table,
+  Column,
+  ForeignKey,
+  BelongsTo,
+  DataType,
+} from 'sequelize-typescript';
+import { Status } from '../utils/enums/status';
+import { Language } from '../utils/enums/language';
+import { Country } from './country.entity';
+import { Gender } from '../utils/enums/gender';
+
+@Table
+export class User extends Model {
+  @Column
+  firstName?: string;
+
+  @Column
+  lastName?: string;
+
+  @Column
+  password!: string;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(Status)),
+    defaultValue: Status.ACTIVE,
+  })
+  status: Status;
+
+  @Column({ allowNull: false, validate: { isEmail: { msg: 'Invalid Email' } } })
+  email!: string;
+
+  @Column
+  phone?: string;
+
+  @Column
+  phoneExt?: string;
+
+  @Column
+  birthday?: Date;
+
+  @Column
+  facebookId?: string;
+
+  @Column
+  googleId?: string;
+
+  @Column
+  appleId?: string;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(Language)),
+    defaultValue: Language.ENGLISH,
+  })
+  preferredLanguage: Language;
+
+  @ForeignKey(() => Country)
+  @Column
+  preferredCountryId?: number;
+
+  @Column
+  profilePic?: string;
+
+  @Column
+  lastLogin!: Date;
+
+  @Column({ allowNull: false, defaultValue: false })
+  isBlocked!: boolean;
+
+  @Column({ defaultValue: false })
+  isVerified: boolean;
+
+  @Column
+  refCode: string;
+
+  @Column({
+    type: DataType.ENUM(...Object.values(Gender)),
+    defaultValue: Gender.PREFER_NOT_TO_SAY,
+  })
+  gender: Gender;
+
+  @BelongsTo(() => Country)
+  country: Country;
+}

package/libs/tatayab-entities-library/src/index.ts

@@ -0,0 +1,12 @@
+import { ModelCtor } from 'sequelize-typescript';
+import { Country } from './entities/country.entity';
+import { Translation } from './entities/translation.entity';
+import ApiKey from './entities/apikey.entity';
+import { Area } from './entities/area.entity';
+import { SysRole } from './entities/sys.role.entity';
+import { SysUser } from './entities/sys.user.entity';
+import { User } from './entities/user.entity';
+
+export function getDbModels(): ModelCtor[] {
+  return [ApiKey, Area, Country, SysRole, SysUser, Translation, User];
+}

package/libs/tatayab-entities-library/src/utils/enums/gender.ts

@@ -0,0 +1,5 @@
+export enum Gender {
+  MALE = 'Male',
+  FEMALE = 'Female',
+  PREFER_NOT_TO_SAY = 'Prefer not to say',
+}

package/libs/tatayab-entities-library/src/utils/enums/language.ts

@@ -0,0 +1,4 @@
+export enum Language {
+  ENGLISH = 'en',
+  ARABIC = 'ar',
+}

package/libs/tatayab-entities-library/src/utils/enums/osName.ts

@@ -0,0 +1,5 @@
+export enum OsName {
+  ANDROID = 'android',
+  IOS = 'iOS',
+  WEB = 'web',
+}

package/libs/tatayab-entities-library/src/utils/enums/productApp.ts

@@ -0,0 +1,4 @@
+export enum ProductApp {
+  DASHBOARD = 'dashboard',
+  USER_APP = 'userapp',
+}

package/libs/tatayab-entities-library/src/utils/enums/status.ts

@@ -0,0 +1,4 @@
+export enum Status {
+  ACTIVE = 'active',
+  IN_ACTIVE = 'inactive',
+}

package/libs/tatayab-entities-library/src/utils/enums/versiontype.ts

@@ -0,0 +1,4 @@
+export enum VersionType {
+  OPTIONAL = 'optional',
+  MANDATORY = 'mandatory',
+}

package/libs/tatayab-entities-library/tsconfig.lib.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "../../dist/libs/trycar-entities-library"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}

package/nest-cli.json

@@ -0,0 +1,18 @@
+{
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "projects": {
+    "trycar-entities-library": {
+      "type": "library",
+      "root": "libs/trycar-entities-library",
+      "entryFile": "index",
+      "sourceRoot": "libs/trycar-entities-library/src",
+      "compilerOptions": {
+        "tsConfigPath": "libs/trycar-entities-library/tsconfig.lib.json"
+      }
+    }
+  },
+  "compilerOptions": {
+    "webpack": true
+  }
+}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "tt-entities",
+  "version": "0.0.1",
+  "description": "Tatayab entities library",
+  "main": "dist/libs/index.js",
+  "types": "dist/libs/index.d.ts",
+  "keywords": [],
+  "author": "Tatayab <technical@tatayab.com>",
+  "license": "ISC",
+  "bugs": {
+    "url": ""
+  },
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "publish-tt": "npm run build && npm publish"
+  },
+  "dependencies": {
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/config": "^4.0.3",
+    "@nestjs/core": "^11.0.1",
+    "@nestjs/platform-express": "^11.0.1",
+    "@nestjs/sequelize": "^11.0.1",
+    "class-validator": "^0.15.1",
+    "mysql2": "^3.18.2",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.1",
+    "sequelize": "^6.37.7",
+    "sequelize-typescript": "^2.1.6"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.18.0",
+    "@nestjs/cli": "^11.0.0",
+    "@nestjs/schematics": "^11.0.0",
+    "@nestjs/testing": "^11.0.1",
+    "@types/express": "^5.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.10.7",
+    "@types/sequelize": "^4.28.20",
+    "@types/supertest": "^6.0.2",
+    "eslint": "^9.18.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.2.2",
+    "globals": "^16.0.0",
+    "jest": "^30.0.0",
+    "prettier": "^3.4.2",
+    "source-map-support": "^0.5.21",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.2.5",
+    "ts-loader": "^9.5.2",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.20.0"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}

package/src/app.module.ts

@@ -0,0 +1,26 @@
+import { Module } from '@nestjs/common';
+import { getDbModels } from '../libs/tatayab-entities-library/src';
+import { SequelizeModule } from '@nestjs/sequelize';
+import { ConfigModule } from '@nestjs/config';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+    }),
+    SequelizeModule.forRoot({
+      dialect: 'mysql',
+      host: process.env.MYSQL_HOST,
+      database: process.env.MYSQL_DATABASE,
+      username: process.env.MYSQL_USER,
+      password: process.env.MYSQL_PASSWORD,
+      port: 3306,
+      autoLoadModels: true,
+      synchronize: true,
+      logging: false,
+      models: getDbModels(),
+    }),
+  ],
+  providers: [],
+})
+export class AppModule {}

package/src/database/config.js

@@ -0,0 +1,35 @@
+require('dotenv').config();
+module.exports = {
+  DEVELOPMENT: {
+    dialect: 'mysql',
+    host: process.env.MYSQL_HOST,
+    port: process.env.MYSQL_PORT,
+    username: process.env.MYSQL_USER,
+    password: process.env.MYSQL_PASS,
+    database: process.env.MYSQL_DATABASE,
+  },
+  LOCAL: {
+    dialect: 'mysql',
+    host: process.env.MYSQL_HOST,
+    port: process.env.MYSQL_PORT,
+    username: process.env.MYSQL_USER,
+    password: process.env.MYSQL_PASS,
+    database: process.env.MYSQL_DATABASE,
+  },
+  STAGING: {
+    dialect: 'mysql',
+    host: process.env.MYSQL_HOST,
+    port: process.env.MYSQL_PORT,
+    username: process.env.MYSQL_USER,
+    password: process.env.MYSQL_PASS,
+    database: process.env.MYSQL_DATABASE,
+  },
+  PRODUCTION: {
+    dialect: 'mysql',
+    host: process.env.MYSQL_HOST,
+    port: process.env.MYSQL_PORT,
+    username: process.env.MYSQL_USER,
+    password: process.env.MYSQL_PASS,
+    database: process.env.MYSQL_DATABASE,
+  },
+};

package/src/main.ts

@@ -0,0 +1,8 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule, { cors: true });
+  await app.listen(process.env.SERVER_PORT ?? 9004);
+}
+bootstrap();

package/test/app.e2e-spec.ts

@@ -0,0 +1,25 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import request from 'supertest';
+import { App } from 'supertest/types';
+import { AppModule } from './../src/app.module';
+
+describe('AppController (e2e)', () => {
+  let app: INestApplication<App>;
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+  });
+
+  it('/ (GET)', () => {
+    return request(app.getHttpServer())
+      .get('/')
+      .expect(200)
+      .expect('Hello World!');
+  });
+});

package/test/jest-e2e.json

@@ -0,0 +1,9 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "resolvePackageJsonExports": true,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2023",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": true,
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "noFallthroughCasesInSwitch": false
+  }
+}