types-salon-management 1.0.1

package/src/models/api/staff-commission-settings.api.model.ts

@@ -0,0 +1,35 @@
+import { CompanyModel } from "../company.model";
+import { CreatedByModel } from "../created-by.model";
+import { Timestamp } from "../timestamp";
+import { EntityType, StaffSaleItemType } from "../../enum";
+import { CommissionRateType, CommissionType, SalesPeriod } from "../../consts";
+import { TierModel } from "../tier.model";
+import { CommissionCalculationRulesModel } from "../commission-calculation-rules.model";
+
+export interface StaffCommissionSettingApiModel {
+  id: string;
+  staffId: string;
+  effectiveDate: Timestamp;
+
+  itemType: StaffSaleItemType;
+
+  active: boolean;
+  type: CommissionType;
+  salesPeriod: SalesPeriod;
+  salesPeriodWeekStart: number | null;
+  rateType: CommissionRateType;
+  amount: number | null;
+  tiers: TierModel[];
+
+  commissionCalculationRules: CommissionCalculationRulesModel;
+
+  company: CompanyModel;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  deletedBy: CreatedByModel | null;
+  source: EntityType;
+}

package/src/models/api/staff-commission.api.model.ts

@@ -0,0 +1,40 @@
+import { CompanyModel } from "../company.model";
+import { CreatedByModel } from "../created-by.model";
+import { Timestamp } from "../timestamp";
+import { EntityType } from "../../enum";
+import { CommissionSettingsModel } from "../commission-settings.model";
+
+export interface StaffCommissionApiModel {
+  id: string;
+  staffId: string;
+  effectiveDate: Timestamp;
+  service: CommissionSettingsModel;
+  product: CommissionSettingsModel;
+  company: CompanyModel;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  deletedBy: CreatedByModel;
+  source: EntityType;
+}
+
+// export type CommissionMode = 'default' | 'custom';
+
+// export interface ServiceCommissionSettingsModel extends CommissionSettingsModel {
+//   services: Record<string, ItemCommissionSettingsModel>;
+// }
+
+// export interface ProductCommissionSettingsModel extends CommissionSettingsModel {
+//   products: Record<string, ItemCommissionSettingsModel>
+// }
+
+// export interface ItemCommissionSettingsModel {
+//   id: string;
+//   active: boolean;
+//   mode: CommissionMode;
+//   rateType: CommissionRateType;
+//   amount: number | null;
+// }

package/src/models/api/staff-item-sale-commission.api.model.ts

@@ -0,0 +1,40 @@
+import { EntityType, StaffSaleItemType, CommissionDirection, CommissionReason } from "../../enum";
+import { CompanyModel } from "../company.model";
+import { CreatedByModel } from "../created-by.model";
+import { Timestamp } from "../timestamp";
+import { OutletModel } from "../outlet.model";
+import { CommissionSettingsModel } from "../commission-settings.model";
+
+export interface StaffItemSaleCommissionApiModel {
+  id: string;
+  staffItemSaleId: string;
+
+  originalInvoiceId: string;
+  originalInvoiceNo: number;
+  originalInvoiceDate: Timestamp;
+
+  staffId: string;
+  itemType: StaffSaleItemType;
+
+  staffCommissionId: string;
+  commissionSettings: CommissionSettingsModel;
+
+  direction: CommissionDirection;
+  reason: CommissionReason; 
+
+  baseAmount: number;
+  commissionAmount: number; // signed (+ / -)
+
+  payRunEffectiveAt: Timestamp;
+
+  location: OutletModel;
+  company: CompanyModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel | null;
+  source: EntityType;
+}

package/src/models/api/staff-item-sale.api.model.ts

@@ -0,0 +1,50 @@
+import { EntityType } from "../../enum";
+import { StaffItemSaleActivityType } from "../../enum/staff-item-sale-activity-type";
+import { StaffSaleItemType } from "../../enum/staff-sale-item-type";
+import { CompanyModel } from "../company.model";
+import { CreatedByModel } from "../created-by.model";
+import { Timestamp } from "../timestamp";
+import { OutletModel } from "../outlet.model";
+
+export interface StaffItemSaleApiModel {
+  id: string;
+
+  invoiceId: string;
+  invoiceNo: number;
+  invoiceDate: Timestamp;
+
+  refundInvoiceId?: string | null;
+  refundInvoiceNo?: number;
+  refundInvoiceDate?: Timestamp;
+
+  // COMMERCIAL SALE IDENTITY (NON-NEGOTIABLE)
+  originalInvoiceId: string; // can be same as invoiceId
+  originalInvoiceNo: number; // can be same as invoiceNo
+  originalInvoiceDate: Timestamp; // can be same as invoiceDate
+
+  isPaid: boolean;
+  invoicePaidAt?: Timestamp | null;
+  voidedAt?: Timestamp | null;
+  staffAddedAt?: Timestamp | null;
+  staffRemovedAt?: Timestamp | null;
+
+  staffId: string;
+  itemType: StaffSaleItemType;
+
+  activityType: StaffItemSaleActivityType;
+  baseAmount: number; // full amount before discount and tax and package redemption
+  discountAmount: number;
+  taxAmount: number;
+  serviceAmountRedeemedByPackage: number;
+
+  location: OutletModel;
+  company: CompanyModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel | null;
+  source: EntityType;
+}

package/src/models/api/staff-pay-run.api.model.ts

@@ -0,0 +1,58 @@
+import { CompanyModel } from '../company.model';
+import { CreatedByModel } from '../created-by.model';
+import { EntityType } from "../../enum";
+import { Timestamp } from "../timestamp";
+import { StaffModel } from '../view';
+import { OutletModel } from '../outlet.model';
+import { PayRunModel } from '../pay-run.model';
+
+
+export interface StaffPayRunApiModel {
+  id: string;
+  payRun: PayRunModel;
+  staff: StaffModel;
+  location: OutletModel;
+
+  hoursWorked: number;
+  hoursWorkedAmount: number;
+
+  hoursOvertime: number;
+  hoursOvertimeAmount: number;
+
+  wages: number;
+  wageAdjustment: number;
+  wagesPaid: number;
+  wagesToPay: number;
+
+  tips: number;
+  tipAdjustment: number;
+  tipsPaid: number;
+  tipsToPay: number;
+
+  serviceCommission: number;
+  productCommission: number;
+  commissionAdjustment: number;
+  totalCommission: number;
+  commissionPaid: number;
+  commissionToPay: number;
+
+  other: number;
+  otherAdjustment: number;
+  otherPaid: number;
+  otherToPay: number;
+
+  earningAmount: number;
+  paidAmount: number;
+  amountToPay: number;
+
+  company: CompanyModel;
+  createdBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedBy: CreatedByModel;
+  updatedAt: Timestamp;
+  isDeleted: boolean;
+  deletedBy: CreatedByModel | null;
+  deletedAt: Timestamp | null;
+  source: EntityType;
+  timezone: string;
+}

package/src/models/api/staff-payroll.api.model.ts

@@ -0,0 +1,37 @@
+import {CompanyModel} from '../company.model';
+import {CreatedByModel} from '../created-by.model';
+import {EntityType} from "../../enum";
+import {Timestamp} from "../timestamp";
+import {OutletModel} from "../outlet.model";
+import {StaffDropdownModel} from "../view";
+
+
+export interface StaffPayrollApiModel {
+    id: string;
+    payrollId: string;
+    salaryDate: number;
+    payrollDate: Timestamp;
+    advancePayment: number;
+    salary: number;
+    serviceTotal: number;
+    serviceCommission: number;
+    productTotal: number;
+    productCommission: number;
+    giftCardTotal: number;
+    giftCardCommission: number;
+    totalSalary: number;
+    staff: StaffDropdownModel;
+    outletIds: string[];
+    outlet: OutletModel[];
+    company: CompanyModel;
+    currencyCode: string;
+    totalWorkTime: number;
+    isDeleted: boolean;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    deletedBy: CreatedByModel | null;
+    source: EntityType;
+}
+
+

package/src/models/api/staff-sales.api.model.ts

@@ -0,0 +1,23 @@
+import {CompanyModel} from '../company.model';
+import {EntityType} from "../../enum";
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+
+export interface StaffSalesApiModel {
+    id: string;
+    productTotal: number;
+    serviceTotal: number;
+    giftCardTotal: number;
+    company: CompanyModel;
+    staffId: string;
+    outletIds: string[];
+    isDeleted: boolean;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+    deletedAt: Timestamp | null;
+    deletedBy: CreatedByModel | null;
+    source: EntityType;
+}
+
+
+

package/src/models/api/staff-schedule.api.model.ts

@@ -0,0 +1,26 @@
+import {CreatedByModel} from '../created-by.model';
+import {TimeApiModel} from './time.api.model';
+import {EntityType} from "../../enum";
+import {Timestamp} from "../timestamp";
+import {ShiftModel} from '../shift.model';
+
+
+export interface StaffScheduleApiModel {
+    staffId: string;
+    outletId: string;
+    companyId: string;
+    date: Timestamp;
+    day: string;
+    dayOfWeek: number;
+    shifts: Array<ShiftModel>;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    updatedAt: TimeApiModel;
+    createdAt: TimeApiModel;
+    deletedAt: TimeApiModel | null;
+    id: string;
+    isDeleted: boolean | null;
+    timeZone: any;
+    deletedBy: CreatedByModel;
+    source: EntityType;
+}

package/src/models/api/staff-shift-schedule.api.model.ts

@@ -0,0 +1,24 @@
+import {CreatedByModel} from '../created-by.model';
+import {ShiftModel} from '../shift.model';
+import {EntityType} from '../../enum';
+import {Timestamp} from '../timestamp';
+
+
+export interface StaffShiftScheduleApiModel {
+    id: string;
+    staffId: string;
+    outletId: string;
+    companyId: string;
+    weeklyShifts: Record<(0 | 1 | 2 | 3 | 4 | 5 | 6), ShiftModel[]>;
+    shiftOverrides: Record<string, ShiftModel[]>;
+    effectiveFrom: Timestamp;
+    effectiveUntil: Timestamp | null;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    source: EntityType;
+    timeZone: string;
+}

package/src/models/api/staff.api.model.ts

@@ -0,0 +1,85 @@
+import { OutletApiModel } from "./outlet.api.model";
+import { CompanyModel } from "../company.model";
+import { QualificationApiModel } from "./qualification.api.model";
+import { BusinessHourApiModel } from "./business-hours.api.model";
+import { Employment } from "../employment.model";
+import { PhoneNumberModel } from "../phone-number-model";
+import { UserRoleApiModel } from "./user-role.api.model";
+import { CountryModel } from "../country.model";
+import { CreatedByModel } from "../created-by.model";
+import { AddressApiModel } from "./address.api.model";
+import { StaffScheduleApiModel } from "./staff-schedule.api.model";
+import { CompensationType, EntityType } from "../../enum";
+import { Timestamp } from "../timestamp";
+import { WarehouseModel } from "../warehouse.model";
+
+export interface StaffApiModel {
+  id: string;
+  title: string;
+  firstName: string;
+  lastName: string;
+  staffImage: string;
+  gender: string;
+  email: string;
+  password: string;
+  order: number;
+  phoneNumber: PhoneNumberModel;
+  userId: string; // TODO: Change this user Id or remove it
+  outlet: Pick<OutletApiModel, "id" | "name">[];
+  outletIds: string[];
+  roles: Pick<UserRoleApiModel, "title" | "value" | "id">;
+  color: string;
+  allowCalendarBooking: boolean;
+  onlineBooking: boolean;
+  address: AddressApiModel;
+  note: string;
+  employment: Employment;
+  showInStaffRoster: boolean;
+  noSms: boolean;
+  company: CompanyModel;
+  
+  country: CountryModel;
+  qualification: Array<Pick<QualificationApiModel, "id" | "name">>;
+  qualificationIds: Array<string>;
+  rosters: any;
+  newRoaster: any;
+  staffSchedules: StaffScheduleApiModel[];
+  designation: string;
+  commissionIds: string[];
+  displayName: string;
+  compensationType: CompensationType;
+  salary: number | null;
+  hourlyRate: number | null;
+  active: boolean;
+  services?: string[];
+  rating?: {
+    total: number;
+    count: number;
+    average: number;
+  };
+  warehouses?: WarehouseModel[];
+  warehouseIds?: string[];
+  isDeleted: boolean;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel | null;
+  source: EntityType;
+}
+
+export interface RosterApiModel {
+  businessHours: Array<BusinessHourApiModel>;
+  date: number;
+}
+
+export interface TimingChangeApiModel {
+  outletId: string;
+  date: number;
+  openingHours: number;
+  closingHours: number;
+  isOpen: true;
+  hours: number;
+  unit: string;
+}

package/src/models/api/stock-adjustments.api.model.ts

@@ -0,0 +1,30 @@
+import {OutletModel} from "../outlet.model";
+import {ProductModel} from "../product.model";
+import {EntityType, StockAdjustmentSource, StockAdjustmentType} from "../../enum";
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+import { CompanyModel } from "../company.model";
+
+export interface StockAdjustmentsApiModel {
+  id: string;
+  productId: string;
+  outletId: string;
+  outlet: OutletModel;
+  product: ProductModel;
+  adjustmentQty: number;
+  reason: string;
+  reasonId: string;
+  stockTakeId?: string;
+  adjustmentSource: StockAdjustmentSource;
+  adjustmentType: StockAdjustmentType;
+  note?: string;
+  company: CompanyModel;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  deletedBy: CreatedByModel;
+  source: EntityType;
+}

package/src/models/api/stock-delivery.api.model.ts

@@ -0,0 +1,32 @@
+import {OutletModel} from '../outlet.model';
+import {ProductApiModel} from './product.api.model';
+import {CompanyModel} from '../company.model';
+import {StaffDropdownModel} from '../view';
+import {TimeApiModel} from './time.api.model';
+import {CreatedByModel} from '../created-by.model';
+import {EntityType} from "../../enum";
+
+export interface StockDeliveryApiModel {
+  id: string;
+  staff: StaffDropdownModel;
+  outlet: OutletModel;
+  deliveryDate: Date;
+  deliveryItems: Array<DeliveryItemModel>;
+  status: boolean;
+  company: CompanyModel;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  createdAt: TimeApiModel;
+  updatedAt: TimeApiModel;
+  deletedAt: TimeApiModel | null;
+  isDeleted: boolean;
+  deletedBy: CreatedByModel;
+  source: EntityType;
+}
+
+export interface DeliveryItemModel {
+  product: ProductApiModel;
+  orderedQty: number;
+  deliveredQty: number;
+  stockVariance: number;
+}

package/src/models/api/stock-history.api.model.ts

@@ -0,0 +1,34 @@
+import {OutletModel} from "../outlet.model";
+import {ProductModel} from "../product.model";
+import {EntityType, MovementCategory, MovementDirection, StockLocationType} from "../../enum";
+import {Timestamp} from "../timestamp";
+import {CreatedByModel} from "../created-by.model";
+import { CompanyModel } from "../company.model";
+import { WarehouseModel } from "../warehouse.model";
+
+export interface StockHistoryApiModel {
+  id: string;
+  productId: string;
+  product: ProductModel;
+  locationId: string;
+  locationType: StockLocationType;
+  location: OutletModel | WarehouseModel;
+  quantity: number;
+  oldStockCount?: number;
+  newStockCount?: number;
+  movementCategory: MovementCategory;
+  movementDirection: MovementDirection;
+  reason: string;
+  reasonId: string;
+  referenceId: string;
+  note: string | null;
+  company: CompanyModel;
+  isDeleted: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  deletedBy: CreatedByModel | null;
+  source: EntityType;
+}

package/src/models/api/stock-order.api.model.ts

@@ -0,0 +1,56 @@
+import {StaffDropdownModel} from '../view';
+import {OutletApiModel} from './outlet.api.model';
+import {EntityType, OrderStatus, PaymentStatus, StockLocationType} from '../../enum';
+import {CompanyModel} from '../company.model';
+import {Timestamp} from '../timestamp';
+import {CreatedByModel} from '../created-by.model';
+import {ProductModel} from "../product.model";
+import {WarehouseModel} from "../warehouse.model";
+import {OutletModel} from "../outlet.model";
+import { SupplierModel } from '../view/supplier.model';
+
+export interface StockOrderApiModel {
+    id: string;
+    orderNo: number;
+    supplier: SupplierModel;
+    locationType: StockLocationType;
+    location: OutletModel | WarehouseModel;
+    orderDate: Timestamp;
+    expectedDeliveryDate: Timestamp;
+    receiveDate: Timestamp;
+    cancelDate: Timestamp;
+    orderItems: Array<OrderItemModel>;
+    totalAmount: number;
+    status: OrderStatus;
+    company: CompanyModel;
+    currencyCode: string;
+    productIds: string[] | null;
+    paymentStatus: PaymentStatus;
+    paymentDueDate: Timestamp;
+    paymentTerms: string;
+    paidAmount?: number;
+    paymentIds?: string[];
+    isLagacy?: boolean;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    companyLogo?: string;
+    deletedBy: CreatedByModel;
+    source: EntityType;
+    
+    // @deprecated
+    staff: StaffDropdownModel;
+    // @deprecated
+    outlet: Pick<OutletApiModel, 'name' | 'id' | 'address' | 'phoneNumber1' | 'phoneNumber2'>;
+}
+
+export interface OrderItemModel {
+    product: ProductModel;
+    price: number;
+    totalPrice: number;
+    orderedQty: number;
+    receivedQty: number;
+}

package/src/models/api/stock-take.api.model.ts

@@ -0,0 +1,36 @@
+import {CompanyModel} from '../company.model';
+import {StaffDropdownModel} from '../view';
+import {Timestamp} from '../timestamp';
+import {CreatedByModel} from '../created-by.model';
+import {OutletModel} from "../outlet.model";
+import {ProductModel} from "../product.model";
+import {EntityType, StockTakeStatus, StockLocationType} from "../../enum";
+import { WarehouseModel } from '../warehouse.model';
+
+export interface StockTakeApiModel {
+    id: string;
+    staff: StaffDropdownModel;
+    locationType: StockLocationType;
+    location: OutletModel | WarehouseModel;
+    takeDate: Timestamp;
+    takenItems: TakeItemModel[];
+    status: StockTakeStatus;
+    company: CompanyModel;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    deletedBy: CreatedByModel;
+    source: EntityType;
+    adjustmentPostedAt?: Timestamp;
+    adjustmentPostedBy?: CreatedByModel;
+}
+
+export interface TakeItemModel {
+    product: ProductModel;
+    countedStockQty: number;
+    systemStockQty: number;
+    stockVariance: number;
+}

package/src/models/api/stock-transfer.api.model.ts

@@ -0,0 +1,49 @@
+import {StaffDropdownModel} from '../view';
+import {EntityType, StockLocationType, StockTransferStatus} from '../../enum';
+import {CompanyModel} from '../company.model';
+import {Timestamp} from '../timestamp';
+import {CreatedByModel} from '../created-by.model';
+import {ProductModel} from "../product.model";
+import {OutletModel} from "../outlet.model";
+import {WarehouseModel} from "../warehouse.model";
+
+export interface StockTransferApiModel {
+    id: string;
+    transferNo: number;
+    staff: StaffDropdownModel;
+    fromOutlet: OutletModel;
+    toOutlet: OutletModel;
+    fromLocationType: StockLocationType;
+    fromLocation: OutletModel | WarehouseModel;
+    toLocationType: StockLocationType;
+    toLocation: OutletModel | WarehouseModel;
+    transferDate: Timestamp;
+    transferItems: TransferItemModel[];
+    totalAmount: number;
+    company: CompanyModel;
+    currencyCode: string;
+    status: StockTransferStatus;
+    productIds: string[] | null;
+    receivedBy: CreatedByModel | null;
+    receivedAt: Timestamp | null;
+    cancelledBy: CreatedByModel | null;
+    cancelledAt: Timestamp | null;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    companyLogo?: string;
+    source: EntityType;
+}
+
+export interface TransferItemModel {
+    product: ProductModel;
+    price: number;
+    totalPrice: number;
+    inStock: number;
+    transferQty: number;
+    receivedQty: number | null;
+}