invoice-system-common 1.0.3 → 1.0.5

package/dist/enums/billing-line-item-status.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum BillingLineItemStatusEnum {
+    UPDATED = "updated",
+    DELETED = "deleted",
+    ACTIVE = "active"
+}

package/dist/enums/billing-line-items-action.enum.d.ts

@@ -0,0 +1,6 @@
+export declare enum BillingLineItemsActionEnum {
+    CREATE = "create",
+    UPDATE = "update",
+    DELETE = "delete",
+    UNCHANGE = "unchange"
+}

package/dist/enums/billing.action.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum BillingActionEnum {
+    EDIT = "edit",
+    APPROVE = "approve",
+    CANCEL = "cancel",
+    SETTLE = "settle",
+    REJECT = "reject"
+}

package/dist/enums/billing.status.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum BillingStatusEnum {
+    PENDING_APPROVAL = "pending_approval",
+    APPROVED = "approved",
+    CANCELLED = "cancelled",
+    SETTLED = "settled",
+    REJECTED = "rejected"
+}

package/dist/enums/currency.enum.d.ts

@@ -0,0 +1,3 @@
+export declare enum CurrencyEnum {
+    INR = "INR"
+}

package/dist/enums/organization.action.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum OrganizationActionEnum {
+    APPROVE = "approve",
+    REJECT = "reject",
+    SUSPEND = "suspend",
+    DELETE = "delete",
+    PENDING = "pending"
+}

package/dist/enums/organization.status.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum OrganizationStatusEnum {
+    PENDING = "pending",
+    APPROVED = "approved",
+    REJECTED = "rejected",
+    SUSPENDED = "suspended",
+    DELETED = "deleted"
+}

package/dist/enums/template.enum.d.ts

@@ -0,0 +1,3 @@
+export declare enum TemplateNameEnum {
+    ROYAL_STEEL_FURNITURE = "royal-steel-furniture.template.html"
+}

package/dist/enums/tenure.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum BillingRateTenureEnum {
+    MONTHLY = "monthly",
+    DAILY = "daily"
+}

package/dist/enums/user.role.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum UserRolesEnum {
+    TOAA = "TOAA",
+    OWNER = "OWNER",
+    STAFF = "STAFF"
+}

package/dist/helpers/audit-column.entity.interface.d.ts

@@ -0,0 +1,6 @@
+export interface IAuditColumnEntity {
+    createdOn: Date;
+    updatedOn: Date;
+    createdBy: number;
+    updatedBy: number;
+}

package/dist/helpers/generics.d.ts

@@ -0,0 +1,6 @@
+import { IAuditColumnEntity } from "./audit-column.entity.interface";
+export type IEntityFilterData<T> = {
+    [K in keyof T]?: T[K][];
+};
+export type IEntityCreateDto<T> = Omit<T, 'id' | keyof IAuditColumnEntity>;
+export type IEntityUpdateDto<T> = Omit<Partial<T>, 'id' | keyof IAuditColumnEntity>;

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+export * from "./interfaces/login.dto.interface";
+export * from "./interfaces/login.response.interface";
+export * from "./interfaces/billing-line-item.dto.interface";
+export * from "./interfaces/billing-line-item.entity.interface";
+export * from "./interfaces/billing.dto.interface";
+export * from "./interfaces/billing.entity.interface";
+export * from "./interfaces/billing.entity.response";
+export * from "./interfaces/bliiling-flow.type";
+export * from "./interfaces/invoice-sequence.dto.interface";
+export * from "./interfaces/invoice-sequence.entity.interface";
+export * from "./interfaces/client.dto.interface";
+export * from "./interfaces/client.entity.interface";
+export * from "./interfaces/category.dto.interface";
+export * from "./interfaces/category.entity.interface";
+export * from "./interfaces/inventory.dto.interface";
+export * from "./interfaces/inventory.entity.interface";
+export * from "./interfaces/organization.dtos.interface";
+export * from "./interfaces/organization.entity.interface";
+export * from "./interfaces/organization.response.interface";
+export * from "./interfaces/rate.dto.interface";
+export * from "./interfaces/rate.entity.interface";
+export * from "./interfaces/user.dto.interface";
+export * from "./interfaces/user.entity.interface";
+export * from "./enums/user.role.enum";
+export * from "./enums/billing-line-item-status.enum";
+export * from "./enums/billing-line-items-action.enum";
+export * from "./enums/billing.action.enum";
+export * from "./enums/billing.status.enum";
+export * from "./enums/tenure.enum";
+export * from "./enums/template.enum";
+export * from "./enums/currency.enum";
+export * from "./enums/organization.action.enum";
+export * from "./enums/organization.status.enum";
+export * from "./helpers/audit-column.entity.interface";
+export * from "./helpers/generics";

package/dist/interfaces/billing-line-item.dto.interface.d.ts

@@ -0,0 +1,13 @@
+import { BillingLineItemsActionEnum } from "../enums/billing-line-items-action.enum";
+import { IEntityCreateDto, IEntityFilterData, IEntityUpdateDto } from "../helpers/generics";
+import { IBillingLineItemEntity } from "./billing-line-item.entity.interface";
+export type IBillingLineItemCreateDtoExclude = 'clientId' | 'status';
+export interface IBillingLineItemCreateDto extends Omit<IEntityCreateDto<IBillingLineItemEntity>, IBillingLineItemCreateDtoExclude> {
+    clientId: number;
+}
+export interface IBillingLineItemUpdateDto extends IEntityUpdateDto<IBillingLineItemEntity> {
+    id: number;
+    action: BillingLineItemsActionEnum;
+}
+export interface IBillingLineItemFilterDto extends IEntityFilterData<IBillingLineItemEntity> {
+}

package/dist/interfaces/billing-line-item.entity.interface.d.ts

@@ -0,0 +1,17 @@
+import { BillingLineItemStatusEnum } from "../enums/billing-line-item-status.enum";
+import { IAuditColumnEntity } from "../helpers/audit-column.entity.interface";
+export interface IBillingLineItemEntity extends IAuditColumnEntity {
+    id: number;
+    billId: number;
+    inventoryId: number;
+    description: string;
+    rateId?: number | null;
+    rateAmount?: number | null;
+    quantity: number;
+    tenureValue: number;
+    normalizedTenureInDays: number;
+    totalAmount: number;
+    startDate: string;
+    endDate: string;
+    status: BillingLineItemStatusEnum;
+}

package/dist/interfaces/billing.dto.interface.d.ts

@@ -0,0 +1,9 @@
+import { IEntityCreateDto, IEntityFilterData, IEntityUpdateDto } from "../helpers/generics";
+import { IBillingEntity } from "./billing.entity.interface";
+export type IBillingCreateDtoExclude = 'status' | 'netBillingAmount';
+export interface IBillingCreateDto extends Omit<IEntityCreateDto<IBillingEntity>, IBillingCreateDtoExclude> {
+}
+export interface IBillingUpdateDto extends IEntityUpdateDto<IBillingEntity> {
+}
+export interface IBillingEntityFilterDto extends IEntityFilterData<IBillingEntity> {
+}

package/dist/interfaces/billing.entity.interface.d.ts

@@ -0,0 +1,20 @@
+import { BillingStatusEnum } from "../enums/billing.status.enum";
+import { BillingRateTenureEnum } from "../enums/tenure.enum";
+import { IAuditColumnEntity } from "../helpers/audit-column.entity.interface";
+export interface IBillingEntity extends IAuditColumnEntity {
+    id: number;
+    startDate: string;
+    endDate: string;
+    clientId: number;
+    billingRateTenure: BillingRateTenureEnum;
+    organizationId: number;
+    invoiceNo: string;
+    invoiceUrl: string | null;
+    referenceClientId: number;
+    totalAmount: number;
+    discount: number;
+    status: BillingStatusEnum;
+    netBillingAmount: number;
+    accountNumber?: string;
+    gstNumber?: string;
+}

package/dist/interfaces/billing.entity.response.d.ts

@@ -0,0 +1,7 @@
+import { IBillingLineItemEntity } from './billing-line-item.entity.interface';
+import { IBillingEntity } from './billing.entity.interface';
+export interface IBillingResponse {
+    billingEntity: IBillingEntity;
+    billingLineItems: IBillingLineItemEntity[];
+}
+export type IBillingSearchResponse = IBillingResponse[];

package/dist/interfaces/bliiling-flow.type.d.ts

@@ -0,0 +1,7 @@
+import { BillingActionEnum } from "../enums/billing.action.enum";
+import { BillingStatusEnum } from "../enums/billing.status.enum";
+export type IBillingFlow = {
+    [K in BillingActionEnum]: {
+        return: () => BillingStatusEnum;
+    };
+};

package/dist/interfaces/category.dto.interface.d.ts

@@ -0,0 +1,9 @@
+import { IEntityCreateDto, IEntityFilterData, IEntityUpdateDto } from '../helpers/generics';
+import { ICategoryEntity } from './category.entity.interface';
+export type ICategoryCreateDtoExclude = 'organizationId';
+export interface ICategoryCreateDto extends Omit<IEntityCreateDto<ICategoryEntity>, ICategoryCreateDtoExclude> {
+}
+export interface ICategoryUpdateDto extends IEntityUpdateDto<ICategoryEntity> {
+}
+export interface ICategoryEntityFilterDto extends IEntityFilterData<ICategoryEntity> {
+}

package/dist/interfaces/category.entity.interface.d.ts

@@ -0,0 +1,7 @@
+import { IAuditColumnEntity } from "../helpers/audit-column.entity.interface";
+export interface ICategoryEntity extends IAuditColumnEntity {
+    id: number;
+    name: string;
+    organizationId: number;
+    description?: string;
+}

package/dist/interfaces/client.dto.interface.d.ts

@@ -0,0 +1,8 @@
+import { IEntityCreateDto, IEntityFilterData, IEntityUpdateDto } from '../helpers/generics';
+import { IClientEntity } from './client.entity.interface';
+export interface IClientCreateDto extends IEntityCreateDto<IClientEntity> {
+}
+export interface IClientUpdateDto extends IEntityUpdateDto<IClientEntity> {
+}
+export interface IClientEntityFilterDto extends IEntityFilterData<IClientEntity> {
+}

package/dist/interfaces/client.entity.interface.d.ts

@@ -0,0 +1,15 @@
+import { IAuditColumnEntity } from "../helpers/audit-column.entity.interface";
+export interface IClientEntity extends IAuditColumnEntity {
+    id: number;
+    name: string;
+    organizationId: number;
+    referenceClientId?: number;
+    primaryContactName: string;
+    primaryContactNumber: string;
+    primaryContactEmail: string;
+    address: string;
+    zipCode: string;
+    city: string;
+    state: string;
+    country: string;
+}

package/dist/interfaces/inventory.dto.interface.d.ts

@@ -0,0 +1,8 @@
+import { IEntityCreateDto, IEntityFilterData, IEntityUpdateDto } from '../helpers/generics';
+import { IInventoryEntity } from './inventory.entity.interface';
+export interface IInventoryCreateDto extends IEntityCreateDto<IInventoryEntity> {
+}
+export interface IInventoryUpdateDto extends IEntityUpdateDto<IInventoryEntity> {
+}
+export interface IInventoryEntityFilterDto extends IEntityFilterData<IInventoryEntity> {
+}

package/dist/interfaces/inventory.entity.interface.d.ts

@@ -0,0 +1,8 @@
+import { IAuditColumnEntity } from "../helpers/audit-column.entity.interface";
+export interface IInventoryEntity extends IAuditColumnEntity {
+    id: number;
+    name: string;
+    categoryId: number;
+    description: string;
+    organizationId: number;
+}

package/dist/interfaces/invoice-sequence.dto.interface.d.ts

@@ -0,0 +1,6 @@
+import { IEntityCreateDto, IEntityFilterData } from '../helpers/generics';
+import { IInvoiceSequenceEntity } from './invoice-sequence.entity.interface';
+export interface IInvoiceSqeuenceEntityCreateDto extends IEntityCreateDto<IInvoiceSequenceEntity> {
+}
+export interface IInvoiceSequenceEntityFilterDto extends IEntityFilterData<IInvoiceSequenceEntity> {
+}

package/dist/interfaces/invoice-sequence.entity.interface.d.ts

@@ -0,0 +1,6 @@
+import { IAuditColumnEntity } from "../helpers/audit-column.entity.interface";
+export interface IInvoiceSequenceEntity extends IAuditColumnEntity {
+    id: number;
+    billingId?: number | null;
+    invoiceNo?: string | null;
+}

package/dist/interfaces/login.dto.interface.d.ts

@@ -0,0 +1,4 @@
+export interface ILoginDto {
+    username: string;
+    password: string;
+}

package/dist/interfaces/login.response.interface.d.ts

@@ -0,0 +1,8 @@
+import { IUserEntity } from "./user.entity.interface";
+export type IUserEntityExclude = 'password';
+export interface IUserEntityExcludeDetails extends Omit<IUserEntity, IUserEntityExclude> {
+}
+export interface ILoginResponse {
+    currentUser: IUserEntityExcludeDetails;
+    accessToken: string;
+}

package/dist/interfaces/organization.dtos.interface.d.ts

@@ -0,0 +1,10 @@
+import { IOrganizationEntity } from './organization.entity.interface';
+import { OrganizationActionEnum } from '../enums/organization.action.enum';
+import { IEntityFilterData } from '../helpers/generics';
+export interface IOrganizationCreateDto extends Partial<IOrganizationEntity> {
+}
+export interface IOrganizationUpdateDto extends Partial<IOrganizationEntity> {
+    action: OrganizationActionEnum;
+}
+export interface IOrganizationEntityFilterDto extends IEntityFilterData<IOrganizationEntity> {
+}

package/dist/interfaces/organization.entity.interface.d.ts

@@ -0,0 +1,18 @@
+import { OrganizationStatusEnum } from '../enums/organization.status.enum';
+import { TemplateNameEnum } from '../enums/template.enum';
+import { IAuditColumnEntity } from '../helpers/audit-column.entity.interface';
+export interface IOrganizationEntity extends IAuditColumnEntity {
+    id: number;
+    name: string;
+    responsiblePersonName: string;
+    primaryContactNo: string;
+    secondaryContactNo: string;
+    email: string;
+    address: string;
+    city: string;
+    zipcode: string;
+    state: string;
+    country: string;
+    templateName?: TemplateNameEnum;
+    status: OrganizationStatusEnum;
+}

package/dist/interfaces/organization.response.interface.d.ts

@@ -0,0 +1,5 @@
+import { IOrganizationEntity } from "./organization.entity.interface";
+import { IUserEntity } from "./user.entity.interface";
+export interface IOrganizationSearchResponse extends IOrganizationEntity {
+    users: IUserEntity[];
+}

package/dist/interfaces/rate.dto.interface.d.ts

@@ -0,0 +1,8 @@
+import { IEntityCreateDto, IEntityFilterData, IEntityUpdateDto } from '../helpers/generics';
+import { IRateEntity } from './rate.entity.interface';
+export interface IRateCreateDto extends IEntityCreateDto<IRateEntity> {
+}
+export interface IRateUpdateDto extends IEntityUpdateDto<IRateEntity> {
+}
+export interface IRateEntityFilterDto extends IEntityFilterData<IRateEntity> {
+}

package/dist/interfaces/rate.entity.interface.d.ts

@@ -0,0 +1,11 @@
+import { CurrencyEnum } from "../enums/currency.enum";
+import { IAuditColumnEntity } from "../helpers/audit-column.entity.interface";
+export interface IRateEntity extends IAuditColumnEntity {
+    id: number;
+    currency: CurrencyEnum;
+    inventoryId: number;
+    organizationId: number;
+    rate: number;
+    startDate: string;
+    endDate: string;
+}

package/dist/interfaces/user.dto.interface.d.ts

@@ -0,0 +1,8 @@
+import { IEntityCreateDto, IEntityFilterData, IEntityUpdateDto } from '../helpers/generics';
+import { IUserEntity } from './user.entity.interface';
+export interface IUserCreateDto extends IEntityCreateDto<IUserEntity> {
+}
+export interface IUserUpdateDto extends IEntityUpdateDto<IUserEntity> {
+}
+export interface IUserEntityFilterDto extends IEntityFilterData<IUserEntity> {
+}

package/dist/interfaces/user.entity.interface.d.ts

@@ -0,0 +1,26 @@
+import { UserRolesEnum } from "../enums/user.role.enum";
+import { IAuditColumnEntity } from "../helpers/audit-column.entity.interface";
+export interface IUserEntity extends IAuditColumnEntity {
+    id: number;
+    name: string;
+    username: string;
+    password: string;
+    contactNo: string;
+    emailId: string;
+    organizationId: number;
+    emergencyContactName: string;
+    emergencyContactNo: string;
+    emergencyContactEmail: string;
+    emergencyContactRelation: string;
+    address: string;
+    city: string;
+    state: string;
+    country: string;
+    zipCode: string;
+    aadharNo: string;
+    aadharUrl?: string;
+    panNo: string;
+    panUrl?: string;
+    role: UserRolesEnum;
+    isResponsiblePerson: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "invoice-system-common",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "",
   "homepage": "https://github.com/Kashyap2210/invoice-system-common#readme",
   "bugs": {