@alba-cars/common-modules 1.2.0

package/dist/global/dto/BaseGetDTO.d.ts

@@ -0,0 +1,8 @@
+import { TypedFilter, TypedOptions } from "../utilities";
+export declare abstract class BaseGetDTO<TEntity extends Record<string, any>, TFilter extends TypedFilter> {
+    filters?: TFilter;
+    options?: TypedOptions<TEntity>;
+    validate(): string[];
+    static fromPlain<T extends BaseGetDTO<any, any>>(this: new () => T, plain: Record<string, unknown>): T;
+    static toPlain(entity: any): Record<string, unknown>;
+}

package/dist/global/dto/BaseGetDTO.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseGetDTO = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+class BaseGetDTO {
+    validate() {
+        const errors = (0, class_validator_1.validateSync)(this);
+        return errors.map((error) => { var _a; return Object.values((_a = error.constraints) !== null && _a !== void 0 ? _a : {}); }).flat();
+    }
+    static fromPlain(plain) {
+        return (0, class_transformer_1.plainToClass)(this, plain);
+    }
+    static toPlain(entity) {
+        return (0, class_transformer_1.instanceToPlain)(entity);
+    }
+}
+exports.BaseGetDTO = BaseGetDTO;

package/dist/global/utilities.d.ts

@@ -0,0 +1,48 @@
+import { ValidationOptions } from "class-validator";
+export type Numeric = number | `${number}`;
+export type Booleanish = boolean | "true" | "1" | "false" | "0";
+export type Optional<T> = T | undefined;
+export type Nullable<T> = T | null;
+export type Maybe<T> = T | null | undefined;
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+export declare function IsDateOrConvertible(validationOptions?: ValidationOptions): (object: Record<string, unknown>, propertyName: string) => void;
+export declare class PaginationOptions {
+    limit?: number;
+    page?: number;
+}
+export declare class DateFilter {
+    from?: Date | string | number;
+    to?: Date | string | number;
+}
+export declare class NumberRange {
+    min?: number;
+    max?: number;
+}
+export declare class BaseFilter {
+    id?: string | string[];
+    createdBy?: string | string[];
+    updatedBy?: string | string[];
+    deletedBy?: string | string[];
+    isDeleted?: boolean;
+    isActive?: boolean;
+    createdAt?: DateFilter;
+    updatedAt?: DateFilter;
+    deletedAt?: DateFilter;
+}
+export type TypedSort<T> = Partial<Record<keyof T, "asc" | "desc">>;
+export type PrefixedKeys<T extends Record<string, any>, Prefix extends string> = `${Prefix}.${keyof T & string}`;
+export type TypedSelect<T, Nested extends Record<string, any>> = keyof T | {
+    [K in keyof Nested]: PrefixedKeys<Nested[K], K & string>;
+}[keyof Nested];
+export declare class TypedFilter extends BaseFilter {
+    [key: string]: unknown;
+}
+export declare class TypedOptions<T extends Record<string, any>> extends PaginationOptions {
+    sort?: TypedSort<T>;
+    select?: string | string[];
+    validate(): string[];
+    static fromPlain(plain: Record<string, unknown>): TypedOptions<Record<string, any>>;
+    static toPlain(entity: any): Record<string, unknown>;
+}

package/dist/global/utilities.js

@@ -0,0 +1,138 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypedOptions = exports.TypedFilter = exports.BaseFilter = exports.NumberRange = exports.DateFilter = exports.PaginationOptions = exports.IsDateOrConvertible = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+function IsDateOrConvertible(validationOptions) {
+    return function (object, propertyName) {
+        (0, class_validator_1.registerDecorator)({
+            name: "isDateOrConvertible",
+            target: object.constructor,
+            propertyName: propertyName,
+            options: validationOptions,
+            validator: {
+                validate(value, _args) {
+                    return value instanceof Date || typeof value === "string" || typeof value === "number";
+                },
+                defaultMessage(args) {
+                    return `${args.property} must be a Date, string, or number`;
+                },
+            },
+        });
+    };
+}
+exports.IsDateOrConvertible = IsDateOrConvertible;
+class PaginationOptions {
+}
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    (0, class_validator_1.Max)(100),
+    __metadata("design:type", Number)
+], PaginationOptions.prototype, "limit", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], PaginationOptions.prototype, "page", void 0);
+exports.PaginationOptions = PaginationOptions;
+class DateFilter {
+}
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.Validate)(IsDateOrConvertible),
+    __metadata("design:type", Object)
+], DateFilter.prototype, "from", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.Validate)(IsDateOrConvertible),
+    __metadata("design:type", Object)
+], DateFilter.prototype, "to", void 0);
+exports.DateFilter = DateFilter;
+class NumberRange {
+}
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], NumberRange.prototype, "min", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], NumberRange.prototype, "max", void 0);
+exports.NumberRange = NumberRange;
+class BaseFilter {
+}
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)({ each: true }),
+    __metadata("design:type", Object)
+], BaseFilter.prototype, "id", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)({ each: true }),
+    __metadata("design:type", Object)
+], BaseFilter.prototype, "createdBy", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)({ each: true }),
+    __metadata("design:type", Object)
+], BaseFilter.prototype, "updatedBy", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)({ each: true }),
+    __metadata("design:type", Object)
+], BaseFilter.prototype, "deletedBy", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsBoolean)(),
+    __metadata("design:type", Boolean)
+], BaseFilter.prototype, "isDeleted", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsBoolean)(),
+    __metadata("design:type", Boolean)
+], BaseFilter.prototype, "isActive", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.Validate)(DateFilter),
+    __metadata("design:type", DateFilter)
+], BaseFilter.prototype, "createdAt", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.Validate)(DateFilter),
+    __metadata("design:type", DateFilter)
+], BaseFilter.prototype, "updatedAt", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.Validate)(DateFilter),
+    __metadata("design:type", DateFilter)
+], BaseFilter.prototype, "deletedAt", void 0);
+exports.BaseFilter = BaseFilter;
+class TypedFilter extends BaseFilter {
+}
+exports.TypedFilter = TypedFilter;
+class TypedOptions extends PaginationOptions {
+    validate() {
+        const errors = (0, class_validator_1.validateSync)(this);
+        return errors.map((error) => { var _a; return Object.values((_a = error.constraints) !== null && _a !== void 0 ? _a : {}); }).flat();
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    static fromPlain(plain) {
+        return (0, class_transformer_1.plainToClass)(TypedOptions, plain);
+    }
+    static toPlain(entity) {
+        return (0, class_transformer_1.instanceToPlain)(entity);
+    }
+}
+exports.TypedOptions = TypedOptions;

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import 'reflect-metadata';
+export * from "./features/vehicle/data/dto/UserDTO";
+export * from "./features/vehicle/data/dto/VehicleMakeDTO";
+export * from "./features/vehicle/data/dto/VehicleModelDTO";
+export * from "./features/vehicle/data/dto/VehicleTypeDTO";
+export * from "./features/vehicle/data/dto/VehicleDTO";
+export * from "./features/vehicle/data/dto/VehicleFinanceDTO";
+export * from "./features/vehicle/data/dto/VehicleOrderDTO";
+export * from "./features/vehicle/data/dto/PaymentDTO";
+export * from './features/sales-team/data/dto/SalesAgentDTO';
+export * from "./features/vehicle/data/dto/VehicleFeatureCategoriesDTO";
+export * from "./features/vehicle/data/dto/VehicleFeatureDTO";
+export * from "./features/test-drive-request/data/dto/TestDriveRequestDTO";
+export * from "./global/utilities";
+export * from "./features/test-drive-request/data/models/";
+export * from "./features/vehicle/data/models/";
+export * from './features/vehicle/data/enums';
+export * from './features/test-drive-request/data/enums';

package/dist/index.js

@@ -0,0 +1,34 @@
+"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 });
+require("reflect-metadata");
+__exportStar(require("./features/vehicle/data/dto/UserDTO"), exports);
+__exportStar(require("./features/vehicle/data/dto/VehicleMakeDTO"), exports);
+__exportStar(require("./features/vehicle/data/dto/VehicleModelDTO"), exports);
+__exportStar(require("./features/vehicle/data/dto/VehicleTypeDTO"), exports);
+__exportStar(require("./features/vehicle/data/dto/VehicleDTO"), exports);
+__exportStar(require("./features/vehicle/data/dto/VehicleFinanceDTO"), exports);
+__exportStar(require("./features/vehicle/data/dto/VehicleOrderDTO"), exports);
+__exportStar(require("./features/vehicle/data/dto/PaymentDTO"), exports);
+__exportStar(require("./features/sales-team/data/dto/SalesAgentDTO"), exports);
+__exportStar(require("./features/vehicle/data/dto/VehicleFeatureCategoriesDTO"), exports);
+__exportStar(require("./features/vehicle/data/dto/VehicleFeatureDTO"), exports);
+__exportStar(require("./features/test-drive-request/data/dto/TestDriveRequestDTO"), exports);
+__exportStar(require("./global/utilities"), exports);
+__exportStar(require("./features/test-drive-request/data/models/"), exports);
+__exportStar(require("./features/vehicle/data/models/"), exports);
+__exportStar(require("./features/vehicle/data/enums"), exports);
+__exportStar(require("./features/test-drive-request/data/enums"), exports);

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@alba-cars/common-modules",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "1.2.0",
+  "description": "A package containing DTOs, validation classes and common modules and interfaces for Alba Cars",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "test": "jest"
+  },
+  "keywords": [
+    "DTO",
+    "validation",
+    "alba-cars",
+    "typescript"
+  ],
+  "author": "Alba Cars",
+  "license": "UNLICENSED",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alba-cars/AlbaCarsCommonModules.git"
+  },
+  "dependencies": {
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1"
+  },
+  "devDependencies": {
+    "@types/node": "^16.11.12",
+    "@types/validator": "^13.12.1",
+    "typescript": "^4.5.5",
+    "jest": "^27.4.7",
+    "@types/jest": "^27.4.0"
+  },
+  "peerDependencies": {
+    "reflect-metadata": "^0.2.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "bugs": {
+    "url": "https://github.com/alba-cars/AlbaCarsCommonModules/issues"
+  },
+  "homepage": "https://github.com/alba-cars/AlbaCarsCommonModules#readme"
+}