@alba-cars/common-modules 2.11.0 → 2.12.0

package/README.md

@@ -1,42 +1,42 @@
-# Alba Cars DTOs
-
-A package containing DTOs, validation classes and common modules and interfaces for Alba Cars
-
-## Installation
-
-```bash
-npm install github:alba-cars/AlbaCarsCommonModules
-```
-
-## Usage
-
-
-## Development
-
-To set up the project for development:
-
-1. Clone the repository:
-```bash
-git clone https://github.com/alba-cars/AlbaCarsCommonModules.git
-```
-
-2. Install dependencies:
-```bash
-npm install
-```
-
-3. Build the package:
-```bash
-npm run prepare
-```
-
-   This command will compile the TypeScript code into JavaScript in the `dist` directory.
-
-4. Run tests:
-```bash
-npm test
-```
-
-## License
-
-This project is unlicensed.
+# Alba Cars DTOs
+
+A package containing DTOs, validation classes and common modules and interfaces for Alba Cars
+
+## Installation
+
+```bash
+npm install github:alba-cars/AlbaCarsCommonModules
+```
+
+## Usage
+
+
+## Development
+
+To set up the project for development:
+
+1. Clone the repository:
+```bash
+git clone https://github.com/alba-cars/AlbaCarsCommonModules.git
+```
+
+2. Install dependencies:
+```bash
+npm install
+```
+
+3. Build the package:
+```bash
+npm run prepare
+```
+
+   This command will compile the TypeScript code into JavaScript in the `dist` directory.
+
+4. Run tests:
+```bash
+npm test
+```
+
+## License
+
+This project is unlicensed.

package/dist/core/enums/Analytics.d.ts

@@ -1,24 +1,24 @@
-export interface MarketingData {
-    Meta?: {
-        utm_source: string;
-        utm_medium: string;
-        utm_campaign: string;
-        utm_content: string;
-    };
-    Google?: {
-        gclid: string;
-        utm_source: string;
-        utm_medium: string;
-        utm_campaign: string;
-        utm_term: string;
-        utm_content: string;
-    };
-    Bing?: {
-        msclkid: string;
-        utm_source: string;
-        utm_medium: string;
-        utm_campaign: string;
-        utm_term: string;
-        utm_content: string;
-    };
-}
+export interface MarketingData {
+    Meta?: {
+        utm_source: string;
+        utm_medium: string;
+        utm_campaign: string;
+        utm_content: string;
+    };
+    Google?: {
+        gclid: string;
+        utm_source: string;
+        utm_medium: string;
+        utm_campaign: string;
+        utm_term: string;
+        utm_content: string;
+    };
+    Bing?: {
+        msclkid: string;
+        utm_source: string;
+        utm_medium: string;
+        utm_campaign: string;
+        utm_term: string;
+        utm_content: string;
+    };
+}

package/dist/core/enums/HttpMethods.d.ts

@@ -1,12 +1,12 @@
-export declare const HttpMethods: {
-    readonly OPTIONS: "OPTIONS";
-    readonly GET: "GET";
-    readonly POST: "POST";
-    readonly PUT: "PUT";
-    readonly PATCH: "PATCH";
-    readonly DELETE: "DELETE";
-    readonly HEAD: "HEAD";
-    readonly CONNECT: "CONNECT";
-    readonly TRACE: "TRACE";
-};
-export type HttpMethodKeys = keyof typeof HttpMethods;
+export declare const HttpMethods: {
+    readonly OPTIONS: "OPTIONS";
+    readonly GET: "GET";
+    readonly POST: "POST";
+    readonly PUT: "PUT";
+    readonly PATCH: "PATCH";
+    readonly DELETE: "DELETE";
+    readonly HEAD: "HEAD";
+    readonly CONNECT: "CONNECT";
+    readonly TRACE: "TRACE";
+};
+export type HttpMethodKeys = keyof typeof HttpMethods;

package/dist/core/enums/HttpStatusCodes.d.ts

@@ -1,18 +1,18 @@
-export declare const HttpStatusCodes: {
-    readonly OK: 200;
-    readonly CREATED: 201;
-    readonly ACCEPTED: 202;
-    readonly NO_CONTENT: 204;
-    readonly BAD_REQUEST: 400;
-    readonly UNAUTHORIZED: 401;
-    readonly FORBIDDEN: 403;
-    readonly NOT_FOUND: 404;
-    readonly METHOD_NOT_ALLOWED: 405;
-    readonly INTERNAL_SERVER_ERROR: 500;
-    readonly NOT_IMPLEMENTED: 501;
-    readonly BAD_GATEWAY: 502;
-    readonly SERVICE_UNAVAILABLE: 503;
-    readonly GATEWAY_TIMEOUT: 504;
-};
-export type HttpStatusKeys = keyof typeof HttpStatusCodes;
-export type HttpStatusCodesValues = (typeof HttpStatusCodes)[HttpStatusKeys];
+export declare const HttpStatusCodes: {
+    readonly OK: 200;
+    readonly CREATED: 201;
+    readonly ACCEPTED: 202;
+    readonly NO_CONTENT: 204;
+    readonly BAD_REQUEST: 400;
+    readonly UNAUTHORIZED: 401;
+    readonly FORBIDDEN: 403;
+    readonly NOT_FOUND: 404;
+    readonly METHOD_NOT_ALLOWED: 405;
+    readonly INTERNAL_SERVER_ERROR: 500;
+    readonly NOT_IMPLEMENTED: 501;
+    readonly BAD_GATEWAY: 502;
+    readonly SERVICE_UNAVAILABLE: 503;
+    readonly GATEWAY_TIMEOUT: 504;
+};
+export type HttpStatusKeys = keyof typeof HttpStatusCodes;
+export type HttpStatusCodesValues = (typeof HttpStatusCodes)[HttpStatusKeys];

package/dist/core/enums/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./HttpMethods";
-export * from "./HttpStatusCodes";
-export * from "./Analytics";
+export * from "./HttpMethods";
+export * from "./HttpStatusCodes";
+export * from "./Analytics";

package/dist/core/error-handling/AppError.d.ts

@@ -1,23 +1,23 @@
-export declare enum ErrorType {
-    VALIDATION_ERROR = "VALIDATION_ERROR",
-    NOT_FOUND = "NOT_FOUND",
-    UNAUTHORIZED = "UNAUTHORIZED",
-    FORBIDDEN = "FORBIDDEN",
-    INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",
-    BAD_REQUEST = "BAD_REQUEST",
-    AUTHENTICATION_ERROR = "AUTHENTICATION_ERROR",
-    AUTHORIZATION_ERROR = "AUTHORIZATION_ERROR"
-}
-export declare class AppError extends Error {
-    message: string;
-    statusCode: number;
-    type: ErrorType;
-    details?: any;
-    constructor(message: string, statusCode: number, type: ErrorType, details?: any);
-    static badRequest(message: string, details?: any): AppError;
-    static notFound(message: string, details?: any): AppError;
-    static unauthorized(message: string, details?: any): AppError;
-    static forbidden(message: string, details?: any): AppError;
-    static internal(message: string, details?: any): AppError;
-    static validationError(message: string, details?: any): AppError;
-}
+export declare enum ErrorType {
+    VALIDATION_ERROR = "VALIDATION_ERROR",
+    NOT_FOUND = "NOT_FOUND",
+    UNAUTHORIZED = "UNAUTHORIZED",
+    FORBIDDEN = "FORBIDDEN",
+    INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",
+    BAD_REQUEST = "BAD_REQUEST",
+    AUTHENTICATION_ERROR = "AUTHENTICATION_ERROR",
+    AUTHORIZATION_ERROR = "AUTHORIZATION_ERROR"
+}
+export declare class AppError extends Error {
+    message: string;
+    statusCode: number;
+    type: ErrorType;
+    details?: any;
+    constructor(message: string, statusCode: number, type: ErrorType, details?: any);
+    static badRequest(message: string, details?: any): AppError;
+    static notFound(message: string, details?: any): AppError;
+    static unauthorized(message: string, details?: any): AppError;
+    static forbidden(message: string, details?: any): AppError;
+    static internal(message: string, details?: any): AppError;
+    static validationError(message: string, details?: any): AppError;
+}

package/dist/core/error-handling/index.d.ts

@@ -1 +1 @@
-export * from "./AppError";
+export * from "./AppError";

package/dist/core/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./error-handling";
-export * from "./enums";
-export * from "./models";
-export * from "./network";
-export * from "./utils";
+export * from "./error-handling";
+export * from "./enums";
+export * from "./models";
+export * from "./network";
+export * from "./utils";

package/dist/core/models/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./pagination";
-export * from "./media";
-export * from "./range";
+export * from "./pagination";
+export * from "./media";
+export * from "./range";

package/dist/core/models/media/index.d.ts

@@ -1 +1 @@
-export * from "./media_data";
+export * from "./media_data";

package/dist/core/models/media/media_data.d.ts

@@ -1,5 +1,5 @@
-export interface FileInput {
-    fileName: string;
-    fileType: string;
-    mediaIndex?: number;
-}
+export interface FileInput {
+    fileName: string;
+    fileType: string;
+    mediaIndex?: number;
+}

package/dist/core/models/pagination/index.d.ts

@@ -1 +1 @@
-export * from "./paginated_data";
+export * from "./paginated_data";

package/dist/core/models/pagination/paginated_data.d.ts

@@ -1,23 +1,23 @@
-import { AppError } from "../../error-handling";
-export declare class DataReturnType<Data = unknown> {
-    constructor(success: boolean, message?: string, data?: Data, error?: AppError);
-    success: boolean;
-    message?: string;
-    data?: Data;
-    error?: AppError;
-}
-export interface PaginatedData<Data = unknown> {
-    result: Data;
-    limit: number;
-    total: number;
-    page: number;
-    isCSVExport?: boolean;
-    exportFields?: Set<string>;
-}
-export declare class ReturnTypeWithPagination<Data = unknown> {
-    success: boolean;
-    message?: string | undefined;
-    data?: PaginatedData<Data> | undefined;
-    error?: AppError | undefined;
-    constructor(success: boolean, message?: string | undefined, data?: PaginatedData<Data> | undefined, error?: AppError | undefined);
-}
+import { AppError } from "../../error-handling";
+export declare class DataReturnType<Data = unknown> {
+    constructor(success: boolean, message?: string, data?: Data, error?: AppError);
+    success: boolean;
+    message?: string;
+    data?: Data;
+    error?: AppError;
+}
+export interface PaginatedData<Data = unknown> {
+    result: Data;
+    limit: number;
+    total: number;
+    page: number;
+    isCSVExport?: boolean;
+    exportFields?: Set<string>;
+}
+export declare class ReturnTypeWithPagination<Data = unknown> {
+    success: boolean;
+    message?: string | undefined;
+    data?: PaginatedData<Data> | undefined;
+    error?: AppError | undefined;
+    constructor(success: boolean, message?: string | undefined, data?: PaginatedData<Data> | undefined, error?: AppError | undefined);
+}

package/dist/core/models/range.d.ts

@@ -1,4 +1,4 @@
-export declare class Range {
-    min?: number;
-    max?: number;
-}
+export declare class Range {
+    min?: number;
+    max?: number;
+}

package/dist/core/network/endpoint-config.d.ts

@@ -1,155 +1,155 @@
-type EndpointFunction = (_id: number | string) => string;
-interface BaseEndpoint {
-    getAll: string | EndpointFunction;
-    create: string | EndpointFunction;
-    getOne: EndpointFunction;
-    deleteOne: EndpointFunction;
-    updateOne: EndpointFunction;
-}
-interface VehicleEndpoints extends BaseEndpoint {
-    getSimilar: EndpointFunction;
-    getOneBySlug: EndpointFunction;
-    getOneByRef: EndpointFunction;
-    publishVehicle: EndpointFunction;
-    unpublishVehicle: EndpointFunction;
-    reserveVehicle: EndpointFunction;
-    selfReserveVehicle: EndpointFunction;
-    markVehicleSold: EndpointFunction;
-    markVehicleDraft: EndpointFunction;
-}
-interface BlogEndpoints extends BaseEndpoint {
-    getOneBySlug: EndpointFunction;
-}
-type MetaEndpoints = BaseEndpoint & {
-    aiGenerateTitle: EndpointFunction;
-    aiGenerateDescription: EndpointFunction;
-    aiGenerateKeyword: EndpointFunction;
-    aiGenerateVehicleDescription: EndpointFunction;
-};
-type DepositEndpoints = BaseEndpoint & {
-    initiateRefund: string | EndpointFunction;
-    getOrCreateUserInformation: string;
-};
-type UserEndpoints = BaseEndpoint & {
-    changeProfilePicture: EndpointFunction;
-    deleteProfilePicture: EndpointFunction;
-};
-type TicketEndpoints = BaseEndpoint & {
-    getMyTickets: string;
-    getUserTickets: EndpointFunction;
-    getAgentTickets: EndpointFunction;
-    addMessage: EndpointFunction;
-    addDocument: EndpointFunction;
-    getDocuments: EndpointFunction;
-    reopenTicket: EndpointFunction;
-    sendToKissFlow: string;
-};
-type ReviewEndpoints = BaseEndpoint & {
-    changeReviewShowPublic: EndpointFunction;
-};
-type VehicleFeatureEndpoints = BaseEndpoint & {
-    changeIcon: EndpointFunction;
-};
-type DealDriveEndpoints = BaseEndpoint & {
-    getAllMakes: EndpointFunction;
-    getAllModels: EndpointFunction;
-};
-type FinanceEligibilityRequestEndpoints = BaseEndpoint & {
-    updateStatus: EndpointFunction;
-};
-type BankValuationRequestEndpoints = BaseEndpoint & {
-    approveValuation: EndpointFunction;
-    rejectValuation: EndpointFunction;
-    overridePayment: EndpointFunction;
-    updateStatus: EndpointFunction;
-    previewCertificatePdf: EndpointFunction;
-    reissueCertificate: EndpointFunction;
-    getCertificateEditableData: EndpointFunction;
-    estimate: string;
-    rangeEstimate: string;
-    getStats: string;
-    notifyAboutExistingLead: string;
-    getRequestStatus: EndpointFunction;
-    checkRequestIsIncomplete: EndpointFunction;
-    sendContinuationReminder: EndpointFunction;
-};
-type ColorEndpoints = BaseEndpoint & {
-    list: string;
-    getBySlug: (slug: string) => string;
-};
-type ExchangeCarRequestEndpoints = {
-    getAll: string;
-    create: string;
-    getOne: EndpointFunction;
-    updateOne: EndpointFunction;
-    deleteOne: EndpointFunction;
-};
-type DubiCarsEndpoints = {
-    getAdByDubiCarsId: EndpointFunction;
-    checkVehicleAdStatus: EndpointFunction;
-    getAvailableModelsForMake: (make: string) => string;
-    postAd: string;
-    doAction: (action: "pause" | "activate" | "refresh" | "sold" | "premium" | "remove-premium") => string;
-    deleteAd: EndpointFunction;
-    deleteAdByVehicleId: EndpointFunction;
-};
-type APIEndpointType = {
-    vehicle: VehicleEndpoints;
-    blogs: BlogEndpoints;
-    vehicleFinance: BaseEndpoint;
-    TestDrive: BaseEndpoint;
-    vehicleMake: BaseEndpoint & {
-        getOneBySlug: (slug: string) => string;
-    };
-    vehicleModel: BaseEndpoint;
-    vehicleMeta: MetaEndpoints;
-    vehicleInspection: BaseEndpoint;
-    vehicleOrder: BaseEndpoint;
-    vehicleFeatures: VehicleFeatureEndpoints;
-    vehicleFeatureCategories: BaseEndpoint;
-    vehicleType: BaseEndpoint;
-    payment: BaseEndpoint;
-    deposit: DepositEndpoints;
-    agents: BaseEndpoint;
-    showroomVisit: BaseEndpoint;
-    sellCarRequest: BaseEndpoint & {
-        notifyAboutExistingLead: string;
-    };
-    financeEligibilityRequest: FinanceEligibilityRequestEndpoints;
-    vehicleReservations: BaseEndpoint;
-    languages: BaseEndpoint;
-    leads: BaseEndpoint;
-    leadPreferences: BaseEndpoint;
-    googleReview: ReviewEndpoints;
-    tickets: TicketEndpoints;
-    user: UserEndpoints;
-    faq: BaseEndpoint;
-    dealDrive: DealDriveEndpoints;
-    bankValuationRequest: BankValuationRequestEndpoints;
-    exchangeCarRequest: ExchangeCarRequestEndpoints;
-    dubiCars: DubiCarsEndpoints;
-    colors: ColorEndpoints;
-    bankValuationResult: BaseEndpoint;
-    bank: BaseEndpoint;
-};
-export declare const API_ENDPOINTS: APIEndpointType;
-export declare const UTIL_ENDPOINTS: {
-    media: {
-        createS3Url: string;
-        preprocessMediaUrl: string;
-        removeS3Media: string;
-        removeVehicleMedia: string;
-        removeByIdentifier: string;
-        compressImage: string;
-    };
-};
-export declare const AUTH_ENDPOINTS: {
-    login: string;
-    register: string;
-    refreshAccessToken: string;
-    sendPhoneVerificationCode: string;
-    verifyPhoneAndLogin: string;
-    verifyAnyPhoneNumber: string;
-    checkPhoneNumberExists: string;
-};
-export {};
+type EndpointFunction = (_id: number | string) => string;
+interface BaseEndpoint {
+    getAll: string | EndpointFunction;
+    create: string | EndpointFunction;
+    getOne: EndpointFunction;
+    deleteOne: EndpointFunction;
+    updateOne: EndpointFunction;
+}
+interface VehicleEndpoints extends BaseEndpoint {
+    getSimilar: EndpointFunction;
+    getOneBySlug: EndpointFunction;
+    getOneByRef: EndpointFunction;
+    publishVehicle: EndpointFunction;
+    unpublishVehicle: EndpointFunction;
+    reserveVehicle: EndpointFunction;
+    selfReserveVehicle: EndpointFunction;
+    markVehicleSold: EndpointFunction;
+    markVehicleDraft: EndpointFunction;
+}
+interface BlogEndpoints extends BaseEndpoint {
+    getOneBySlug: EndpointFunction;
+}
+type MetaEndpoints = BaseEndpoint & {
+    aiGenerateTitle: EndpointFunction;
+    aiGenerateDescription: EndpointFunction;
+    aiGenerateKeyword: EndpointFunction;
+    aiGenerateVehicleDescription: EndpointFunction;
+};
+type DepositEndpoints = BaseEndpoint & {
+    initiateRefund: string | EndpointFunction;
+    getOrCreateUserInformation: string;
+};
+type UserEndpoints = BaseEndpoint & {
+    changeProfilePicture: EndpointFunction;
+    deleteProfilePicture: EndpointFunction;
+};
+type TicketEndpoints = BaseEndpoint & {
+    getMyTickets: string;
+    getUserTickets: EndpointFunction;
+    getAgentTickets: EndpointFunction;
+    addMessage: EndpointFunction;
+    addDocument: EndpointFunction;
+    getDocuments: EndpointFunction;
+    reopenTicket: EndpointFunction;
+    sendToKissFlow: string;
+};
+type ReviewEndpoints = BaseEndpoint & {
+    changeReviewShowPublic: EndpointFunction;
+};
+type VehicleFeatureEndpoints = BaseEndpoint & {
+    changeIcon: EndpointFunction;
+};
+type DealDriveEndpoints = BaseEndpoint & {
+    getAllMakes: EndpointFunction;
+    getAllModels: EndpointFunction;
+};
+type FinanceEligibilityRequestEndpoints = BaseEndpoint & {
+    updateStatus: EndpointFunction;
+};
+type BankValuationRequestEndpoints = BaseEndpoint & {
+    approveValuation: EndpointFunction;
+    rejectValuation: EndpointFunction;
+    overridePayment: EndpointFunction;
+    updateStatus: EndpointFunction;
+    previewCertificatePdf: EndpointFunction;
+    reissueCertificate: EndpointFunction;
+    getCertificateEditableData: EndpointFunction;
+    estimate: string;
+    rangeEstimate: string;
+    getStats: string;
+    notifyAboutExistingLead: string;
+    getRequestStatus: EndpointFunction;
+    checkRequestIsIncomplete: EndpointFunction;
+    sendContinuationReminder: EndpointFunction;
+};
+type ColorEndpoints = BaseEndpoint & {
+    list: string;
+    getBySlug: (slug: string) => string;
+};
+type ExchangeCarRequestEndpoints = {
+    getAll: string;
+    create: string;
+    getOne: EndpointFunction;
+    updateOne: EndpointFunction;
+    deleteOne: EndpointFunction;
+};
+type DubiCarsEndpoints = {
+    getAdByDubiCarsId: EndpointFunction;
+    checkVehicleAdStatus: EndpointFunction;
+    getAvailableModelsForMake: (make: string) => string;
+    postAd: string;
+    doAction: (action: "pause" | "activate" | "refresh" | "sold" | "premium" | "remove-premium") => string;
+    deleteAd: EndpointFunction;
+    deleteAdByVehicleId: EndpointFunction;
+};
+type APIEndpointType = {
+    vehicle: VehicleEndpoints;
+    blogs: BlogEndpoints;
+    vehicleFinance: BaseEndpoint;
+    TestDrive: BaseEndpoint;
+    vehicleMake: BaseEndpoint & {
+        getOneBySlug: (slug: string) => string;
+    };
+    vehicleModel: BaseEndpoint;
+    vehicleMeta: MetaEndpoints;
+    vehicleInspection: BaseEndpoint;
+    vehicleOrder: BaseEndpoint;
+    vehicleFeatures: VehicleFeatureEndpoints;
+    vehicleFeatureCategories: BaseEndpoint;
+    vehicleType: BaseEndpoint;
+    payment: BaseEndpoint;
+    deposit: DepositEndpoints;
+    agents: BaseEndpoint;
+    showroomVisit: BaseEndpoint;
+    sellCarRequest: BaseEndpoint & {
+        notifyAboutExistingLead: string;
+    };
+    financeEligibilityRequest: FinanceEligibilityRequestEndpoints;
+    vehicleReservations: BaseEndpoint;
+    languages: BaseEndpoint;
+    leads: BaseEndpoint;
+    leadPreferences: BaseEndpoint;
+    googleReview: ReviewEndpoints;
+    tickets: TicketEndpoints;
+    user: UserEndpoints;
+    faq: BaseEndpoint;
+    dealDrive: DealDriveEndpoints;
+    bankValuationRequest: BankValuationRequestEndpoints;
+    exchangeCarRequest: ExchangeCarRequestEndpoints;
+    dubiCars: DubiCarsEndpoints;
+    colors: ColorEndpoints;
+    bankValuationResult: BaseEndpoint;
+    bank: BaseEndpoint;
+};
+export declare const API_ENDPOINTS: APIEndpointType;
+export declare const UTIL_ENDPOINTS: {
+    media: {
+        createS3Url: string;
+        preprocessMediaUrl: string;
+        removeS3Media: string;
+        removeVehicleMedia: string;
+        removeByIdentifier: string;
+        compressImage: string;
+    };
+};
+export declare const AUTH_ENDPOINTS: {
+    login: string;
+    register: string;
+    refreshAccessToken: string;
+    sendPhoneVerificationCode: string;
+    verifyPhoneAndLogin: string;
+    verifyAnyPhoneNumber: string;
+    checkPhoneNumberExists: string;
+};
+export {};