@mody-park-cha-raja/finance_common 4.38.1-beta.0 → 4.38.1-beta.2

package/dist/index.d.mts

@@ -1311,6 +1311,74 @@ interface IVendorUpdateDto extends IEntityUpdateDto<EntityType<EntityList.VENDOR
 interface IVendorSearchDto extends IEntityFilterData<EntityType<EntityList.VENDOR>> {
 }
 
+type RealtimeEntityType = EntityList.DONATION | EntityList.EXPENSE | EntityList.SPONSOR | EntityList.TRANSACTION;
+declare enum RealtimeEventAction {
+    CREATED = "created",
+    UPDATED = "updated",
+    DELETED = "deleted",
+    REFRESH = "refresh"
+}
+type RealtimeEventByType = {
+    [K in RealtimeEntityType]: {
+        type: K;
+        action: RealtimeEventAction.CREATED | RealtimeEventAction.UPDATED;
+        organizationId: number;
+        data: EntityType<K>;
+    };
+};
+type RealtimeEventDeleted = {
+    [K in RealtimeEntityType]: {
+        type: K;
+        action: RealtimeEventAction.DELETED;
+        organizationId: number;
+        data: {
+            id: number;
+        };
+    };
+};
+type RealtimeEventRefresh = {
+    [K in RealtimeEntityType]: {
+        type: K;
+        action: RealtimeEventAction.REFRESH;
+        organizationId: number;
+    };
+};
+type RealtimeEvent = RealtimeEventByType[RealtimeEntityType] | RealtimeEventDeleted[RealtimeEntityType] | RealtimeEventRefresh[RealtimeEntityType];
+type StorePatchCallbacks = {
+    [K in RealtimeEntityType]: {
+        upsert: (entity: EntityType<K>) => void;
+        remove: (id: number) => void;
+    };
+};
+
+interface RealtimeSocketOptions {
+    url: string;
+    token: string;
+    onConnect?: () => void;
+    onDisconnect?: (reason: string) => void;
+    onError?: (error: Error) => void;
+}
+type SocketInstance = {
+    on: (event: string, cb: (...args: any[]) => void) => void;
+    off: (event: string, cb: (...args: any[]) => void) => void;
+    emit: (event: string, ...args: any[]) => void;
+    disconnect: () => void;
+    connected: boolean;
+};
+type SocketFactory = (url: string, opts: any) => SocketInstance;
+declare function registerSocketFactory(f: SocketFactory): void;
+declare function connectSocket(options: RealtimeSocketOptions): SocketInstance;
+declare function disconnectSocket(): void;
+declare function getSocket(): SocketInstance | null;
+
+type VersionMap = Map<string, number>;
+type RealtimeSync = {
+    bind: () => void;
+    unbind: () => void;
+    versions: VersionMap;
+};
+declare function createRealtimeSync(callbacks: StorePatchCallbacks): RealtimeSync;
+
 declare const FLAT_WING_PATTERN: RegExp;
 declare const SHOP_WING = "SH";
 declare const SPECIAL_FLAT_LABELS: readonly ["Devotee", "Ex-Member Devotee", "Others"];
@@ -1325,4 +1393,4 @@ declare function isSpecialFlatLabel(label: string): boolean;
 declare function getFlatValidationErrors(input: Partial<IFlatEntity>): FlatValidationError[];
 declare function validateFlatOrThrow(input: Partial<IFlatEntity>): void;
 
-export { ALL_WINGS_SELECTION, AartiModel, BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHeadHistoryModel, ExpenseHeadModel, ExpenseHistoryModel, ExpenseModel, FLATS_BY_WING, FLAT_DONATION_RELATION_CONFIG, FLAT_NUMBERS, FLAT_UNIT_NUMBER_PATTERN, FLAT_WING_PATTERN, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatHistoryModel, type FlatIdDonationLike, FlatModel, type FlatOption, type FlatParseResult, type FlatValidationError, ForbiddenException, HttpException, type IAartiCreateDto, type IAartiEntity, type IAartiSearchDto, type IAartiUpdateDto, type IAuditColumnEntity, type IBaseHistoryEntity, type ICashBookEntry, type IConfigurationCreateDto, type IConfigurationEntity, type IConfigurationSearchDto, type IConfigurationUpdateDto, type IDonationCreateDto, type IDonationEntity, type IDonationHistoryEntity, type IDonationSearchDto, type IDonationUpdateDto, type IDtoValidationError, type IEntityCreateDto, type IEntityFilterData, type IEntityFilterSearchData, type IEntityFilterSearchDataV2, type IEntityUpdateDto, type IExpenseCreateDto, type IExpenseEntity, type IExpenseHeadCreateDto, type IExpenseHeadEntity, type IExpenseHeadHistoryEntity, type IExpenseHeadSearchDto, type IExpenseHeadUpdateDto, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IFlatCreateDto, type IFlatEntity, type IFlatHistoryEntity, type IFlatSearchDto, type IFlatUpdateDto, type IMappingPropertyEntry, type IModelRelationConfig, type IOrganizationCreateDto, type IOrganizationEntity, type IOrganizationUpdateDto, type ISearchV2Response, type ISponsorCreateDto, type ISponsorEntity, type ISponsorHistoryEntity, type ISponsorSearchDto, type ISponsorUpdateDto, type ITransactionCreateDto, type ITransactionEntity, type ITransactionHistoryEntity, type ITransactionSearchDto, type ITransactionUpdateDto, type IUserCreateDto, type IUserEntity, type IUserHistoryEntity, type IUserSearchDto, type IUserUpdateDto, type IVendorBillCreateDto, type IVendorBillEntity, type IVendorBillHistoryEntity, type IVendorBillSearchDto, type IVendorBillUpdateDto, type IVendorCreateDto, type IVendorEntity, type IVendorHistoryEntity, type IVendorSearchDto, type IVendorUpdateDto, NotFoundException, type Nullable, OrderByDirection, OrganizationModel, PAYMENT_OPTIONS, PaymentType, ReferenceIdPrefix, RelationType, SHOP_UNIT_NUMBER_PATTERN, SHOP_WING, SPECIAL_FLATS, SPECIAL_FLAT_LABELS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionEntityType, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, type UserExpenseReport, type UserExpenseReportTotals, type UserExpenseRow, UserHistoryModel, UserModel, VendorBillHistoryModel, VendorBillModel, VendorBillStatus, VendorHistoryModel, VendorModel, VendorType, WINGS, WING_ALPHABETS, type WingCollectionDonationByIdLike, type WingCollectionDonationLike, type WingCollectionReport, type WingCollectionRow, type WingCollectionTotals, type XlsxCellAddress, type XlsxMergeRange, type XlsxSerializationType, type XlsxSheetInput, type XlsxSheetOptions, buildUserExpenseReport, buildUserExpenseWorkbook, buildWingWiseCollectionReport, buildWingWiseCollectionReportByFlatId, buildWingWiseCollectionWorkbook, buildXlsxWorkbook, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getFlatValidationErrors, getObjectDiffingKeys, getWingSelectionLabel, getWingSelectionSlug, groupBy, isSpecialFlatLabel, isValidFlatWing, roundToTwoDecimals, serializeXlsx, validateFlatOrThrow };
+export { ALL_WINGS_SELECTION, AartiModel, BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHeadHistoryModel, ExpenseHeadModel, ExpenseHistoryModel, ExpenseModel, FLATS_BY_WING, FLAT_DONATION_RELATION_CONFIG, FLAT_NUMBERS, FLAT_UNIT_NUMBER_PATTERN, FLAT_WING_PATTERN, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatHistoryModel, type FlatIdDonationLike, FlatModel, type FlatOption, type FlatParseResult, type FlatValidationError, ForbiddenException, HttpException, type IAartiCreateDto, type IAartiEntity, type IAartiSearchDto, type IAartiUpdateDto, type IAuditColumnEntity, type IBaseHistoryEntity, type ICashBookEntry, type IConfigurationCreateDto, type IConfigurationEntity, type IConfigurationSearchDto, type IConfigurationUpdateDto, type IDonationCreateDto, type IDonationEntity, type IDonationHistoryEntity, type IDonationSearchDto, type IDonationUpdateDto, type IDtoValidationError, type IEntityCreateDto, type IEntityFilterData, type IEntityFilterSearchData, type IEntityFilterSearchDataV2, type IEntityUpdateDto, type IExpenseCreateDto, type IExpenseEntity, type IExpenseHeadCreateDto, type IExpenseHeadEntity, type IExpenseHeadHistoryEntity, type IExpenseHeadSearchDto, type IExpenseHeadUpdateDto, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IFlatCreateDto, type IFlatEntity, type IFlatHistoryEntity, type IFlatSearchDto, type IFlatUpdateDto, type IMappingPropertyEntry, type IModelRelationConfig, type IOrganizationCreateDto, type IOrganizationEntity, type IOrganizationUpdateDto, type ISearchV2Response, type ISponsorCreateDto, type ISponsorEntity, type ISponsorHistoryEntity, type ISponsorSearchDto, type ISponsorUpdateDto, type ITransactionCreateDto, type ITransactionEntity, type ITransactionHistoryEntity, type ITransactionSearchDto, type ITransactionUpdateDto, type IUserCreateDto, type IUserEntity, type IUserHistoryEntity, type IUserSearchDto, type IUserUpdateDto, type IVendorBillCreateDto, type IVendorBillEntity, type IVendorBillHistoryEntity, type IVendorBillSearchDto, type IVendorBillUpdateDto, type IVendorCreateDto, type IVendorEntity, type IVendorHistoryEntity, type IVendorSearchDto, type IVendorUpdateDto, NotFoundException, type Nullable, OrderByDirection, OrganizationModel, PAYMENT_OPTIONS, PaymentType, type RealtimeEntityType, type RealtimeEvent, RealtimeEventAction, type RealtimeSocketOptions, type RealtimeSync, ReferenceIdPrefix, RelationType, SHOP_UNIT_NUMBER_PATTERN, SHOP_WING, SPECIAL_FLATS, SPECIAL_FLAT_LABELS, type SocketFactory, type SocketInstance, SponsorHistoryModel, SponsorModel, SponsorTier, type StorePatchCallbacks, TransactionEntityType, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, type UserExpenseReport, type UserExpenseReportTotals, type UserExpenseRow, UserHistoryModel, UserModel, VendorBillHistoryModel, VendorBillModel, VendorBillStatus, VendorHistoryModel, VendorModel, VendorType, type VersionMap, WINGS, WING_ALPHABETS, type WingCollectionDonationByIdLike, type WingCollectionDonationLike, type WingCollectionReport, type WingCollectionRow, type WingCollectionTotals, type XlsxCellAddress, type XlsxMergeRange, type XlsxSerializationType, type XlsxSheetInput, type XlsxSheetOptions, buildUserExpenseReport, buildUserExpenseWorkbook, buildWingWiseCollectionReport, buildWingWiseCollectionReportByFlatId, buildWingWiseCollectionWorkbook, buildXlsxWorkbook, connectSocket, convertNumberToWords, createRealtimeSync, definedValues, diffArrays, disconnectSocket, entityListEntityModelMap, epochToReadableDate, getFlatValidationErrors, getObjectDiffingKeys, getSocket, getWingSelectionLabel, getWingSelectionSlug, groupBy, isSpecialFlatLabel, isValidFlatWing, registerSocketFactory, roundToTwoDecimals, serializeXlsx, validateFlatOrThrow };

package/dist/index.d.ts

@@ -1311,6 +1311,74 @@ interface IVendorUpdateDto extends IEntityUpdateDto<EntityType<EntityList.VENDOR
 interface IVendorSearchDto extends IEntityFilterData<EntityType<EntityList.VENDOR>> {
 }
 
+type RealtimeEntityType = EntityList.DONATION | EntityList.EXPENSE | EntityList.SPONSOR | EntityList.TRANSACTION;
+declare enum RealtimeEventAction {
+    CREATED = "created",
+    UPDATED = "updated",
+    DELETED = "deleted",
+    REFRESH = "refresh"
+}
+type RealtimeEventByType = {
+    [K in RealtimeEntityType]: {
+        type: K;
+        action: RealtimeEventAction.CREATED | RealtimeEventAction.UPDATED;
+        organizationId: number;
+        data: EntityType<K>;
+    };
+};
+type RealtimeEventDeleted = {
+    [K in RealtimeEntityType]: {
+        type: K;
+        action: RealtimeEventAction.DELETED;
+        organizationId: number;
+        data: {
+            id: number;
+        };
+    };
+};
+type RealtimeEventRefresh = {
+    [K in RealtimeEntityType]: {
+        type: K;
+        action: RealtimeEventAction.REFRESH;
+        organizationId: number;
+    };
+};
+type RealtimeEvent = RealtimeEventByType[RealtimeEntityType] | RealtimeEventDeleted[RealtimeEntityType] | RealtimeEventRefresh[RealtimeEntityType];
+type StorePatchCallbacks = {
+    [K in RealtimeEntityType]: {
+        upsert: (entity: EntityType<K>) => void;
+        remove: (id: number) => void;
+    };
+};
+
+interface RealtimeSocketOptions {
+    url: string;
+    token: string;
+    onConnect?: () => void;
+    onDisconnect?: (reason: string) => void;
+    onError?: (error: Error) => void;
+}
+type SocketInstance = {
+    on: (event: string, cb: (...args: any[]) => void) => void;
+    off: (event: string, cb: (...args: any[]) => void) => void;
+    emit: (event: string, ...args: any[]) => void;
+    disconnect: () => void;
+    connected: boolean;
+};
+type SocketFactory = (url: string, opts: any) => SocketInstance;
+declare function registerSocketFactory(f: SocketFactory): void;
+declare function connectSocket(options: RealtimeSocketOptions): SocketInstance;
+declare function disconnectSocket(): void;
+declare function getSocket(): SocketInstance | null;
+
+type VersionMap = Map<string, number>;
+type RealtimeSync = {
+    bind: () => void;
+    unbind: () => void;
+    versions: VersionMap;
+};
+declare function createRealtimeSync(callbacks: StorePatchCallbacks): RealtimeSync;
+
 declare const FLAT_WING_PATTERN: RegExp;
 declare const SHOP_WING = "SH";
 declare const SPECIAL_FLAT_LABELS: readonly ["Devotee", "Ex-Member Devotee", "Others"];
@@ -1325,4 +1393,4 @@ declare function isSpecialFlatLabel(label: string): boolean;
 declare function getFlatValidationErrors(input: Partial<IFlatEntity>): FlatValidationError[];
 declare function validateFlatOrThrow(input: Partial<IFlatEntity>): void;
 
-export { ALL_WINGS_SELECTION, AartiModel, BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHeadHistoryModel, ExpenseHeadModel, ExpenseHistoryModel, ExpenseModel, FLATS_BY_WING, FLAT_DONATION_RELATION_CONFIG, FLAT_NUMBERS, FLAT_UNIT_NUMBER_PATTERN, FLAT_WING_PATTERN, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatHistoryModel, type FlatIdDonationLike, FlatModel, type FlatOption, type FlatParseResult, type FlatValidationError, ForbiddenException, HttpException, type IAartiCreateDto, type IAartiEntity, type IAartiSearchDto, type IAartiUpdateDto, type IAuditColumnEntity, type IBaseHistoryEntity, type ICashBookEntry, type IConfigurationCreateDto, type IConfigurationEntity, type IConfigurationSearchDto, type IConfigurationUpdateDto, type IDonationCreateDto, type IDonationEntity, type IDonationHistoryEntity, type IDonationSearchDto, type IDonationUpdateDto, type IDtoValidationError, type IEntityCreateDto, type IEntityFilterData, type IEntityFilterSearchData, type IEntityFilterSearchDataV2, type IEntityUpdateDto, type IExpenseCreateDto, type IExpenseEntity, type IExpenseHeadCreateDto, type IExpenseHeadEntity, type IExpenseHeadHistoryEntity, type IExpenseHeadSearchDto, type IExpenseHeadUpdateDto, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IFlatCreateDto, type IFlatEntity, type IFlatHistoryEntity, type IFlatSearchDto, type IFlatUpdateDto, type IMappingPropertyEntry, type IModelRelationConfig, type IOrganizationCreateDto, type IOrganizationEntity, type IOrganizationUpdateDto, type ISearchV2Response, type ISponsorCreateDto, type ISponsorEntity, type ISponsorHistoryEntity, type ISponsorSearchDto, type ISponsorUpdateDto, type ITransactionCreateDto, type ITransactionEntity, type ITransactionHistoryEntity, type ITransactionSearchDto, type ITransactionUpdateDto, type IUserCreateDto, type IUserEntity, type IUserHistoryEntity, type IUserSearchDto, type IUserUpdateDto, type IVendorBillCreateDto, type IVendorBillEntity, type IVendorBillHistoryEntity, type IVendorBillSearchDto, type IVendorBillUpdateDto, type IVendorCreateDto, type IVendorEntity, type IVendorHistoryEntity, type IVendorSearchDto, type IVendorUpdateDto, NotFoundException, type Nullable, OrderByDirection, OrganizationModel, PAYMENT_OPTIONS, PaymentType, ReferenceIdPrefix, RelationType, SHOP_UNIT_NUMBER_PATTERN, SHOP_WING, SPECIAL_FLATS, SPECIAL_FLAT_LABELS, SponsorHistoryModel, SponsorModel, SponsorTier, TransactionEntityType, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, type UserExpenseReport, type UserExpenseReportTotals, type UserExpenseRow, UserHistoryModel, UserModel, VendorBillHistoryModel, VendorBillModel, VendorBillStatus, VendorHistoryModel, VendorModel, VendorType, WINGS, WING_ALPHABETS, type WingCollectionDonationByIdLike, type WingCollectionDonationLike, type WingCollectionReport, type WingCollectionRow, type WingCollectionTotals, type XlsxCellAddress, type XlsxMergeRange, type XlsxSerializationType, type XlsxSheetInput, type XlsxSheetOptions, buildUserExpenseReport, buildUserExpenseWorkbook, buildWingWiseCollectionReport, buildWingWiseCollectionReportByFlatId, buildWingWiseCollectionWorkbook, buildXlsxWorkbook, convertNumberToWords, definedValues, diffArrays, entityListEntityModelMap, epochToReadableDate, getFlatValidationErrors, getObjectDiffingKeys, getWingSelectionLabel, getWingSelectionSlug, groupBy, isSpecialFlatLabel, isValidFlatWing, roundToTwoDecimals, serializeXlsx, validateFlatOrThrow };
+export { ALL_WINGS_SELECTION, AartiModel, BadRequestException, BaseEntityModel, ConfigurationKey, ConfigurationModel, ConfigurationType, DateCodeUtils, DateUtil, DonationHistoryModel, DonationModel, EntityFilterDataHelper, EntityHistoryOperation, EntityList, type EntityListEntityModelMap, type EntityModelType, EntityStatus, type EntityType, ExpenseHeadHistoryModel, ExpenseHeadModel, ExpenseHistoryModel, ExpenseModel, FLATS_BY_WING, FLAT_DONATION_RELATION_CONFIG, FLAT_NUMBERS, FLAT_UNIT_NUMBER_PATTERN, FLAT_WING_PATTERN, type FlatCollectionEntry, type FlatCollectionStatus, type FlatDonationLike, FlatHistoryModel, type FlatIdDonationLike, FlatModel, type FlatOption, type FlatParseResult, type FlatValidationError, ForbiddenException, HttpException, type IAartiCreateDto, type IAartiEntity, type IAartiSearchDto, type IAartiUpdateDto, type IAuditColumnEntity, type IBaseHistoryEntity, type ICashBookEntry, type IConfigurationCreateDto, type IConfigurationEntity, type IConfigurationSearchDto, type IConfigurationUpdateDto, type IDonationCreateDto, type IDonationEntity, type IDonationHistoryEntity, type IDonationSearchDto, type IDonationUpdateDto, type IDtoValidationError, type IEntityCreateDto, type IEntityFilterData, type IEntityFilterSearchData, type IEntityFilterSearchDataV2, type IEntityUpdateDto, type IExpenseCreateDto, type IExpenseEntity, type IExpenseHeadCreateDto, type IExpenseHeadEntity, type IExpenseHeadHistoryEntity, type IExpenseHeadSearchDto, type IExpenseHeadUpdateDto, type IExpenseHistoryEntity, type IExpenseSearchDto, type IExpenseUpdateDto, type IFlatCreateDto, type IFlatEntity, type IFlatHistoryEntity, type IFlatSearchDto, type IFlatUpdateDto, type IMappingPropertyEntry, type IModelRelationConfig, type IOrganizationCreateDto, type IOrganizationEntity, type IOrganizationUpdateDto, type ISearchV2Response, type ISponsorCreateDto, type ISponsorEntity, type ISponsorHistoryEntity, type ISponsorSearchDto, type ISponsorUpdateDto, type ITransactionCreateDto, type ITransactionEntity, type ITransactionHistoryEntity, type ITransactionSearchDto, type ITransactionUpdateDto, type IUserCreateDto, type IUserEntity, type IUserHistoryEntity, type IUserSearchDto, type IUserUpdateDto, type IVendorBillCreateDto, type IVendorBillEntity, type IVendorBillHistoryEntity, type IVendorBillSearchDto, type IVendorBillUpdateDto, type IVendorCreateDto, type IVendorEntity, type IVendorHistoryEntity, type IVendorSearchDto, type IVendorUpdateDto, NotFoundException, type Nullable, OrderByDirection, OrganizationModel, PAYMENT_OPTIONS, PaymentType, type RealtimeEntityType, type RealtimeEvent, RealtimeEventAction, type RealtimeSocketOptions, type RealtimeSync, ReferenceIdPrefix, RelationType, SHOP_UNIT_NUMBER_PATTERN, SHOP_WING, SPECIAL_FLATS, SPECIAL_FLAT_LABELS, type SocketFactory, type SocketInstance, SponsorHistoryModel, SponsorModel, SponsorTier, type StorePatchCallbacks, TransactionEntityType, TransactionHistoryModel, TransactionModel, TransactionType, USER_RELATION_CONFIG, UnauthorizedException, type UserExpenseReport, type UserExpenseReportTotals, type UserExpenseRow, UserHistoryModel, UserModel, VendorBillHistoryModel, VendorBillModel, VendorBillStatus, VendorHistoryModel, VendorModel, VendorType, type VersionMap, WINGS, WING_ALPHABETS, type WingCollectionDonationByIdLike, type WingCollectionDonationLike, type WingCollectionReport, type WingCollectionRow, type WingCollectionTotals, type XlsxCellAddress, type XlsxMergeRange, type XlsxSerializationType, type XlsxSheetInput, type XlsxSheetOptions, buildUserExpenseReport, buildUserExpenseWorkbook, buildWingWiseCollectionReport, buildWingWiseCollectionReportByFlatId, buildWingWiseCollectionWorkbook, buildXlsxWorkbook, connectSocket, convertNumberToWords, createRealtimeSync, definedValues, diffArrays, disconnectSocket, entityListEntityModelMap, epochToReadableDate, getFlatValidationErrors, getObjectDiffingKeys, getSocket, getWingSelectionLabel, getWingSelectionSlug, groupBy, isSpecialFlatLabel, isValidFlatWing, registerSocketFactory, roundToTwoDecimals, serializeXlsx, validateFlatOrThrow };

package/dist/index.js

@@ -63,6 +63,7 @@ __export(index_exports, {
   OrganizationModel: () => OrganizationModel,
   PAYMENT_OPTIONS: () => PAYMENT_OPTIONS,
   PaymentType: () => PaymentType,
+  RealtimeEventAction: () => RealtimeEventAction,
   ReferenceIdPrefix: () => ReferenceIdPrefix,
   RelationType: () => RelationType,
   SHOP_UNIT_NUMBER_PATTERN: () => SHOP_UNIT_NUMBER_PATTERN,
@@ -94,18 +95,23 @@ __export(index_exports, {
   buildWingWiseCollectionReportByFlatId: () => buildWingWiseCollectionReportByFlatId,
   buildWingWiseCollectionWorkbook: () => buildWingWiseCollectionWorkbook,
   buildXlsxWorkbook: () => buildXlsxWorkbook,
+  connectSocket: () => connectSocket,
   convertNumberToWords: () => convertNumberToWords,
+  createRealtimeSync: () => createRealtimeSync,
   definedValues: () => definedValues,
   diffArrays: () => diffArrays,
+  disconnectSocket: () => disconnectSocket,
   entityListEntityModelMap: () => entityListEntityModelMap,
   epochToReadableDate: () => epochToReadableDate,
   getFlatValidationErrors: () => getFlatValidationErrors,
   getObjectDiffingKeys: () => getObjectDiffingKeys,
+  getSocket: () => getSocket,
   getWingSelectionLabel: () => getWingSelectionLabel,
   getWingSelectionSlug: () => getWingSelectionSlug,
   groupBy: () => groupBy,
   isSpecialFlatLabel: () => isSpecialFlatLabel,
   isValidFlatWing: () => isValidFlatWing,
+  registerSocketFactory: () => registerSocketFactory,
   roundToTwoDecimals: () => roundToTwoDecimals,
   serializeXlsx: () => serializeXlsx,
   validateFlatOrThrow: () => validateFlatOrThrow
@@ -2417,6 +2423,110 @@ var USER_RELATION_CONFIG = {
   columnKeys: ["id", "name"]
 };
 
+// src/realtime/realtime.types.ts
+var RealtimeEventAction = /* @__PURE__ */ ((RealtimeEventAction2) => {
+  RealtimeEventAction2["CREATED"] = "created";
+  RealtimeEventAction2["UPDATED"] = "updated";
+  RealtimeEventAction2["DELETED"] = "deleted";
+  RealtimeEventAction2["REFRESH"] = "refresh";
+  return RealtimeEventAction2;
+})(RealtimeEventAction || {});
+
+// src/realtime/realtime.socket.ts
+var socket = null;
+var factory = null;
+function registerSocketFactory(f) {
+  factory = f;
+}
+function connectSocket(options) {
+  if (socket?.connected) return socket;
+  if (!factory)
+    throw new Error(
+      "Socket factory not registered. Call registerSocketFactory() first."
+    );
+  socket = factory(options.url, {
+    auth: { token: options.token },
+    reconnection: true,
+    reconnectionAttempts: Infinity,
+    reconnectionDelay: 1e3,
+    reconnectionDelayMax: 5e3,
+    timeout: 1e4
+  });
+  if (options.onConnect) socket.on("connect", options.onConnect);
+  if (options.onDisconnect) socket.on("disconnect", options.onDisconnect);
+  if (options.onError) socket.on("connect_error", options.onError);
+  return socket;
+}
+function disconnectSocket() {
+  if (socket) {
+    socket.disconnect();
+    socket = null;
+  }
+}
+function getSocket() {
+  return socket;
+}
+
+// src/realtime/realtime.sync.ts
+var EVENT_NAME = "realtime-event";
+function createRealtimeSync(callbacks) {
+  const versions = /* @__PURE__ */ new Map();
+  let bound = false;
+  function keyFor(type, id) {
+    return `${type}:${id}`;
+  }
+  function applyUpsert(type, entity) {
+    const entityId = entity.id;
+    const entityVersion = entity.updatedOn;
+    const key = keyFor(type, entityId);
+    const currentVersion = versions.get(key);
+    if (currentVersion !== void 0 && currentVersion >= entityVersion) {
+      return;
+    }
+    versions.set(key, entityVersion);
+    callbacks[type].upsert(entity);
+  }
+  function handleEvent(event) {
+    if (event.action === "refresh" /* REFRESH */) {
+      return;
+    }
+    if (event.action === "deleted" /* DELETED */) {
+      callbacks[event.type].remove(event.data.id);
+      versions.delete(keyFor(event.type, event.data.id));
+      return;
+    }
+    switch (event.type) {
+      case "donation" /* DONATION */:
+        applyUpsert(event.type, event.data);
+        break;
+      case "expense" /* EXPENSE */:
+        applyUpsert(event.type, event.data);
+        break;
+      case "sponsor" /* SPONSOR */:
+        applyUpsert(event.type, event.data);
+        break;
+      case "transaction" /* TRANSACTION */:
+        applyUpsert(event.type, event.data);
+        break;
+    }
+  }
+  function bind() {
+    if (bound) return;
+    const socket2 = getSocket();
+    if (!socket2) return;
+    socket2.on(EVENT_NAME, handleEvent);
+    bound = true;
+  }
+  function unbind() {
+    if (!bound) return;
+    const socket2 = getSocket();
+    if (!socket2) return;
+    socket2.off(EVENT_NAME, handleEvent);
+    bound = false;
+  }
+  return { bind, unbind, versions };
+}
+
 // src/validators/flat.validator.ts
 var FLAT_WING_PATTERN = /^[A-Z]$/;
 var SHOP_WING = "SH";
@@ -2524,6 +2634,7 @@ function validateFlatOrThrow(input) {
   OrganizationModel,
   PAYMENT_OPTIONS,
   PaymentType,
+  RealtimeEventAction,
   ReferenceIdPrefix,
   RelationType,
   SHOP_UNIT_NUMBER_PATTERN,
@@ -2555,18 +2666,23 @@ function validateFlatOrThrow(input) {
   buildWingWiseCollectionReportByFlatId,
   buildWingWiseCollectionWorkbook,
   buildXlsxWorkbook,
+  connectSocket,
   convertNumberToWords,
+  createRealtimeSync,
   definedValues,
   diffArrays,
+  disconnectSocket,
   entityListEntityModelMap,
   epochToReadableDate,
   getFlatValidationErrors,
   getObjectDiffingKeys,
+  getSocket,
   getWingSelectionLabel,
   getWingSelectionSlug,
   groupBy,
   isSpecialFlatLabel,
   isValidFlatWing,
+  registerSocketFactory,
   roundToTwoDecimals,
   serializeXlsx,
   validateFlatOrThrow