types-salon-management 1.0.1

package/src/enum/razorpay-billing-cycle.ts

@@ -0,0 +1,7 @@
+export enum RazorpayBillingCycle {
+    Monthly = "monthly",
+    Yearly = "yearly",
+    Quarterly = "quarterly",
+    Weekly = "weekly",
+    Daily = "daily"
+}

package/src/enum/razorpay-subscription-status.ts

@@ -0,0 +1,12 @@
+export enum RazorpaySubscriptionStatus {
+    Created = 'created',
+    Authenticated = 'authenticated',
+    Active = 'active',
+    Pending = 'pending',
+    Halted = 'halted',
+    Cancelled = 'cancelled',
+    Completed = 'completed',
+    Expired = 'expired',
+    Paused = 'paused',
+}
+

package/src/enum/redeem-type.ts

@@ -0,0 +1,4 @@
+export enum RedeemType {
+    Redeem = 'redeem',
+    Refund = 'refund',
+}

package/src/enum/refund-status.ts

@@ -0,0 +1,5 @@
+export enum RefundStatus {
+    Pending = 'pending',
+    Processed = 'processed',
+    Failed = 'failed',
+}

package/src/enum/roles-enum.ts

@@ -0,0 +1,10 @@
+// eslint-disable-next-line no-shadow
+export enum Roles {
+  superAdmin = 'super_admin',
+  onboardingAdmin = 'onboarding_admin',
+  supportAdmin = 'support_admin',
+  companyAdmin = 'company_admin',
+  manager = 'manager',
+  receptionist = 'receptionist',
+  staff = 'staff',
+}

package/src/enum/service-price-type.ts

@@ -0,0 +1,5 @@
+export enum ServicePricingType {
+    Free = 'free',
+    StartAt = 'Start at',
+    Fixed = 'fixed'
+}

package/src/enum/service-type.ts

@@ -0,0 +1,5 @@
+// eslint-disable-next-line no-shadow
+export enum ServiceType {
+  Service = 'service',
+  Stage = 'stage',
+};

package/src/enum/staff-attendance-approval-status.ts

@@ -0,0 +1,8 @@
+
+export enum StaffAttendanceApprovalStatus {
+    Approved = 'approved',
+    Rejected = 'rejected',
+    Pending = 'pending',
+    AutoApproved = 'autoApproved',
+    AutoRejected = 'autoRejected',
+}

package/src/enum/staff-attendance-status.ts

@@ -0,0 +1,4 @@
+export enum StaffAttendanceStatus {
+    ClockedIn = 'clocked in',
+    ClockedOut = 'clocked out'
+}

package/src/enum/staff-item-sale-activity-type.ts

@@ -0,0 +1,7 @@
+export enum StaffItemSaleActivityType {
+  InvoiceCreated = "invoiceCreated",
+  InvoiceRefunded = "invoiceRefunded",
+  InvoiceVoided = "invoiceVoided",
+  StaffRemoved = "staffRemoved",
+  StaffAdded = "staffAdded"
+}

package/src/enum/staff-sale-item-type.ts

@@ -0,0 +1,4 @@
+export enum StaffSaleItemType {
+  Service = "service",
+  Product = "product"
+}

package/src/enum/stock-adjustment-source.ts

@@ -0,0 +1,4 @@
+export const enum StockAdjustmentSource {
+    Manual = 'manual',
+    StockTake = 'stock_take',
+}

package/src/enum/stock-adjustment-type.ts

@@ -0,0 +1,5 @@
+export const enum StockAdjustmentType {
+    Increase = 'increase',
+    Decrease = 'decrease',
+    None = 'none',
+}

package/src/enum/stock-location-type.ts

@@ -0,0 +1,4 @@
+export enum StockLocationType {
+    Outlet = 'outlet',
+    Warehouse = 'warehouse',
+}

package/src/enum/stock-take-status.ts

@@ -0,0 +1,5 @@
+export enum StockTakeStatus {
+    Draft = 'draft',
+    Completed = 'completed',
+    Adjusted = 'adjusted',
+}

package/src/enum/stock-transfer-status.ts

@@ -0,0 +1,6 @@
+export enum StockTransferStatus {
+    Received = 'received',
+    Ordered = 'ordered',
+    Draft = 'draft',
+    Cancelled = 'cancelled',
+}

package/src/enum/stripe-billing-cycle.ts

@@ -0,0 +1,4 @@
+export enum StripeBillingCycle {
+    Month = "month",
+    Year = "year"
+}

package/src/enum/subscription-status.ts

@@ -0,0 +1,14 @@
+export enum SubscriptionStatus {
+    Free = 'free',
+    Trial = 'trial',
+    PendingPaymentMethod = 'pendingPaymentMethod',
+    Pending = 'pending',
+    Active = 'active',
+    Cancelled = 'cancelled',
+
+    Inactive = 'inactive',
+    Completed = 'completed',
+    Paused = 'paused',
+    OnHold = 'onHold',
+    Expired = 'expired',
+}

package/src/enum/tax-calculation-method.ts

@@ -0,0 +1,4 @@
+export enum TaxCalculationMethod {
+    Inclusive = 'inclusive',
+    Exclusive = 'exclusive',
+}

package/src/enum/tax-category.ts

@@ -0,0 +1,4 @@
+export enum TaxCategory {
+    Individual = 'individual',
+    Group = 'group',
+}

package/src/enum/tax-type.ts

@@ -0,0 +1,5 @@
+// eslint-disable-next-line no-shadow
+export enum TaxType {
+    Default = 'default',
+    Custom = 'custom',
+}

package/src/enum/time-unit.ts

@@ -0,0 +1,5 @@
+export enum TimeUnit  {
+    Day = 'day',
+    Week = 'week',
+    Month = 'month',
+}

package/src/enum/transaction-type.ts

@@ -0,0 +1,4 @@
+export enum TransactionType {
+    SmsRecharge = 'SMS Recharge',
+    WhatsappRecharge = 'Whatsapp Recharge',
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './models/index';
+export * from './enum/index';
+export * from './consts/index';

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

@@ -0,0 +1,22 @@
+import { AddonValue } from '../../consts';
+import { CreatedByModel } from '../created-by.model';
+import { Timestamp } from '../timestamp';
+
+export interface AddonApiModel {
+  id: string;
+  name: AddonValue;
+  description: string;
+  active: boolean;
+  superAdminOnly: boolean;
+  logo: string;
+  countries: string[];
+  order: number;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy?: CreatedByModel | null;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  timeZone: string;
+}

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

@@ -0,0 +1,12 @@
+export interface AddressApiModel {
+    addressLine1: string;
+    state: string;
+    street: string;
+    country: string;
+    postalCode: string;
+    city: string;
+    location: any;
+    formattedAddress?: string;
+    landmark?: string | null;
+    placeId?: string | null;
+}

package/src/models/api/admin-user.api.model.ts

@@ -0,0 +1,30 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {PhoneNumberModel} from "../phone-number-model";
+import {UserRoleModel} from "../user-role.model";
+import {CountryModel} from "../country.model";
+import {EntityType} from "../../enum";
+
+export interface AdminUserApiModel {
+    id: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    password: string;
+    phoneNumber: PhoneNumberModel | null;
+    roles: UserRoleModel;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    photoURL: string | null;
+    color: string;
+    country: CountryModel;
+    source: EntityType;
+    timeZone: string;
+    userId: string;
+    displayName?: string;
+}

package/src/models/api/appointment-reminder.api.model.ts

@@ -0,0 +1,26 @@
+import {CreatedByModel} from '../created-by.model';
+import {EntityType} from '../../enum';
+import {Timestamp} from '../timestamp';
+import {ClientApiModel} from "./client.api.model";
+import {CompanyModel} from "../company.model";
+import {OutletModel} from "../outlet.model";
+
+export interface AppointmentReminderApiModel {
+    id: string;
+    appointmentId: string;
+    appointmentDate: Timestamp;
+    appointmentReminderDate: Timestamp;
+    client: ClientApiModel;
+    company: CompanyModel;
+    outlet: OutletModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp;
+    isDeleted: boolean;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    timeZone: string;
+    source: EntityType;
+}
+

package/src/models/api/appointment-status.api.model.ts

@@ -0,0 +1,23 @@
+import {OutletModel} from '../outlet.model';
+import {CompanyModel} from '../company.model';
+import {TimeApiModel} from './time.api.model';
+import {CreatedByModel} from '../created-by.model';
+import {EntityType} from "../../enum";
+
+export interface AppointmentStatusApiModel {
+  id: string;
+  name: string;
+  outlet: OutletModel;
+  description: string;
+  company: CompanyModel;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  updatedAt: TimeApiModel;
+  createdAt: TimeApiModel;
+  deletedAt: TimeApiModel | null;
+  isDeleted: boolean;
+  color: string;
+  active: boolean;
+  deletedBy: CreatedByModel;
+  source: EntityType;
+}

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

@@ -0,0 +1,197 @@
+import {OutletModel} from '../outlet.model';
+import {AppointmentStatusApiModel} from './appointment-status.api.model';
+import {CompanyModel} from '../company.model';
+import {ClientApiModel} from './client.api.model';
+import {RazorpaySuccessResponse} from '../razorpay.model';
+import {CreatedByModel, PerformedBy} from '../created-by.model';
+import {OutletApiModel} from './outlet.api.model';
+import {
+    AppointmentItemType,
+    AppointmentStatus,
+    BookingType,
+    ClientType,
+    EntityType,
+    EventType,
+    PaymentStatus,
+    PricingType,
+    RefundStatus,
+    TaxType
+} from '../../enum';
+import {MasterData} from '../master-data.model';
+import {TaxSettingModel} from '../tax-setting.model';
+import {PriceModel} from '../price.model';
+import {PaymentModel} from '../payment.model';
+import {Timestamp} from '../timestamp';
+import {PaymentMethodModel} from '../payment-method';
+import {ContraindicationModel, DealDropDownModel} from '../view';
+import {DurationSegment} from '../duration.model';
+
+export type Outlet = OutletModel & OutletApiModel;
+export type AppointmentItemApiModel = ServiceAppointmentItemApiModel | ServiceComboAppointmentItemApiModel;
+
+export interface AppointmentApiModel extends ServiceAppointmentItemApiModel {
+    id: string;
+    appointmentRef: string;
+    groupId: string;
+    groupAppointmentId: string | null;
+    isPrimary: boolean;
+    note: string;
+    type: EventType;
+    outlet: Outlet;
+    outletInfo?: OutletApiModel;
+    company: CompanyModel;
+    onlineBookingDuringBlockTime?: boolean;
+    client?: ClientApiModel;
+    clientType: ClientType;
+    status?: Array<AppointmentStatusApiModel>;
+    appStatus?: AppointmentStatus;
+    invoiceId?: string | null;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp;
+    isDeleted: boolean;
+    appointmentDate: Timestamp;
+    items: Record<string, AppointmentItemApiModel>;
+    itemId?: string;
+    notify: boolean;
+    /**
+     *  @deprecated this property is deprecated and remove in future version. no longer in use
+     */
+    cancelledData: any;
+    cancellation: Cancellation;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel;
+    currencyCode: string;
+    timeZone: string;
+    paymentStatus: PaymentStatus;
+    paymentInfo: RazorpaySuccessResponse;
+    paymentVerified: boolean;
+    bookBy: EntityType;
+    payment?: PaymentModel,
+    onlinePaymentDetails?: PaymentModel,
+    onlinePaymentAmount?: number;
+    paymentMethod?: PaymentMethodModel,
+    refund?: Refund;
+    /**
+     * only apply when appointment is booked by client
+     */
+    convenienceFee?: number;
+    transactionFee?: number;
+    /**
+     * it's used when appointment is selected on calendar
+     */
+    selected?: boolean;
+    comboId?: string;
+    source: EntityType;
+    redeemedLoyaltyPoints?: number,
+    loyaltyPointDiscount?: number,
+    hasPendingLoyaltyPoints?: boolean,
+    staffUserIds: string[] | null,
+    noShowScheduledAt: Timestamp | null,
+}
+
+export interface RoomResourceApiModel {
+    id: string;
+    name: string;
+    capacity: number;
+    type: string;
+    qualify?: boolean;
+}
+
+export interface StaffResourceApiModel {
+    id: string;
+    fullName: string;
+    title: string;
+    firstName: string;
+    lastName: string;
+    color: string;
+    type: string;
+    staffImage: string;
+    qualificationIds: Array<string>;
+    businessHours: Array<any>;
+    favorite?: boolean;
+    qualify?: boolean;
+}
+
+export interface ServiceAppointmentItemApiModel {
+    id: string;
+    staff: StaffResourceApiModel;
+    staff2?: StaffResourceApiModel;
+    service: ServiceItemModel;
+    room?: RoomResourceApiModel;
+    start: number;
+    end: number;
+    durationSegments: DurationSegment[];
+    addedBy: EntityType;
+    itemType: AppointmentItemType;
+    deal?: DealDropDownModel;
+    beforeAfterImages?: BeforeAfterImageApiModel[];
+    consentForm?: string;
+}
+
+export interface ServiceComboAppointmentItemApiModel {
+    id: string;
+    name: string;
+    price: string;
+    comboItems: Record<string, ServiceAppointmentItemApiModel>;
+    bookingType: BookingType;
+    pricingType: PricingType;
+    itemType: AppointmentItemType;
+    start: number;
+    end: number;
+    addedBy: EntityType;
+}
+
+
+export interface ServiceItemModel {
+    id: string;
+    name: string;
+    duration: MasterData;
+    taxType: TaxType;
+    taxSettings: Record<string, TaxSettingModel>;
+    price: PriceModel;
+    serviceOriginalPrice: PriceModel;
+    displayPrice: string;
+    originalPrice: string;
+    discountPriceAvailable: boolean;
+    qualifiedStaff: string[];
+    qualifiedRoom: string[];
+    color: string;
+    contraindication: ContraindicationModel[];
+    servicePrice: string;
+    advancePriceId?: string | null
+    variantId?: string | null;
+    requiresTwoStaffs?: boolean;
+}
+
+export interface Refund {
+    id: string;
+    amount: number;
+    status: RefundStatus
+}
+
+
+export interface Cancellation {
+    notify: boolean;
+    reason: string;
+    performedBy: PerformedBy;
+    byType: EntityType;
+}
+
+export interface ReSchedule {
+    notify: boolean;
+    reason: string;
+    performedAt: Timestamp;
+    performedBy: PerformedBy;
+    byType: EntityType;
+}
+
+export interface BeforeAfterImageApiModel {
+    beforeImageUrl: string;
+    beforeTimestamp: Timestamp;
+    afterImageUrl: string;
+    afterTimestamp: Timestamp;
+    serviceName: string;
+    description?: string;
+}

package/src/models/api/billing-payment-method.api.model.ts

@@ -0,0 +1,54 @@
+import { CompanyModel } from "../company.model";
+import { Timestamp } from "../timestamp";
+import { CreatedByModel } from "../created-by.model";
+import { EntityType, PaymentCardBrand, PaymentGateway } from "../../enum";
+import { BillingEntityModel } from "../billing-entity.model";
+
+export interface BillingPaymentMethodApiModel {
+  id: string;
+  active: boolean;
+  paymentGateway: PaymentGateway;
+  method: "card" | "upi";
+  card?: CardModel | null;
+  upi?: UpiModel | null;
+  razorpayData?: RazorpayMethodDataModel | null;
+  company: CompanyModel;
+  billingEntity: BillingEntityModel;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel | null;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  source: EntityType;
+}
+
+export interface RazorpayMethodDataModel {
+  customerId: string;
+  orderId: string;
+  paymentId: string;
+  invoiceId: string;
+  tokenId: string;
+  razorpaySignature: string;
+  customerResponse: Record<string, any>;
+  orderResponse: Record<string, any>;
+  paymentResponse: Record<string, any>;
+}
+
+export interface CardModel {
+  id: string;
+  brand: PaymentCardBrand;
+  last4: string;
+  name?: string;
+  expirationMonth?: string;
+  expirationYear?: string;
+  bin?: string;
+  cvv?: string;
+  type?: 'credit' | 'debit';
+  issuer?: string; 
+}
+
+export interface UpiModel {
+  vpa: string;
+}

package/src/models/api/booking-domain.api.model.ts

@@ -0,0 +1,40 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {EntityType} from "../../enum";
+
+export interface FaviconSet {
+    faviconIco?: string;        // Standard favicon.ico
+    favicon16?: string;         // 16x16 PNG favicon
+    favicon32?: string;         // 32x32 PNG favicon
+    appleTouchIcon?: string;    // 180x180 Apple touch icon
+}
+
+export interface DomainBranding {
+    primaryColor?: string;      // Main brand color
+    secondaryColor?: string;    // Secondary brand color
+    accentColor?: string;       // Accent color for highlights
+    textColor?: string;         // Primary text color
+    logoUrl?: string;           // URL to company logo
+    favicons?: FaviconSet;      // Set of favicon URLs
+    fontFamily?: string;        // Custom font family
+}
+
+export interface BookingDomainApiModel {
+    id?: string;
+    domainName: string;
+    companyId: string;
+    companySlug: string;
+    verified: boolean;
+    active: boolean;
+    locations: string[];
+    branding?: DomainBranding;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy: CreatedByModel | null;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean | null;
+    source: EntityType;
+    timeZone: string;
+}

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

@@ -0,0 +1,25 @@
+import {CreatedByModel} from '../created-by.model';
+import {CompanyModel} from '../company.model';
+import {TimeApiModel} from './time.api.model';
+import {EntityType} from "../../enum";
+import { CreationSource } from '../../consts';
+import { ProductApiModel } from './product.api.model';
+
+export interface BrandApiModel {
+  id: string;
+  name: string;
+  description: string;
+  active: boolean;
+  company: CompanyModel;
+  products: Array<Pick<ProductApiModel, 'id' | 'name'>>;
+  creationSource: CreationSource;
+  importBatchId?: string;
+  createdAt: TimeApiModel;
+  updatedAt: TimeApiModel;
+  deletedAt: TimeApiModel | null;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel;
+  isDeleted: boolean;
+  source: EntityType;
+}

package/src/models/api/business-category.api.model.ts

@@ -0,0 +1,19 @@
+import {CreatedByModel} from "../created-by.model";
+import {Timestamp} from "../timestamp";
+import {EntityType} from "../../enum";
+
+export interface BusinessCategoryApiModel {
+  id: string;
+  name: string;
+  description: string;
+  image: string;
+  active: boolean;
+  createdBy: CreatedByModel;
+  updatedBy: CreatedByModel;
+  deletedBy: CreatedByModel;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+  isDeleted: boolean;
+  source: EntityType;
+}

package/src/models/api/business-hours.api.model.ts

@@ -0,0 +1,9 @@
+export interface BusinessHourApiModel {
+    day: string;
+    dayOfWeek: number;
+    isOpen: boolean;
+    openingHours: number;
+    closingHours: number;
+    hours?: number;
+    unit: string;
+}

package/src/models/api/business-payment-method.api.model.ts

@@ -0,0 +1,19 @@
+import { EntityType } from "../../enum";
+import { CreatedByModel } from "../created-by.model";
+import { Timestamp } from "../timestamp";
+
+export interface BusinessPaymentMethodApiModel {
+    id: string;
+    name: string;
+    isDefault: boolean;
+    isActive: boolean;
+    source: EntityType;
+    createdBy: CreatedByModel;
+    updatedBy: CreatedByModel;
+    deletedBy?: CreatedByModel;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    deletedAt: Timestamp | null;
+    isDeleted: boolean;
+    timeZone: string;
+}