@bisondesk/core-sdk 1.0.621 → 1.0.622

package/src/types/opportunities.ts

@@ -4,7 +4,7 @@ import { BusinessEntityIds, OpportunityType, WarningHints } from '../constants.j
 import { Contact, Organization } from './crm.js';
 import type { Interest, InterestBffMeta } from './interests.js';
 import { BaseEvent } from './internal-events.js';
-import { Payment } from './payments.js';
+import { OpportunityPayment } from './opportunity-payments.js';
 import { Quote, QuoteStatus } from './quotes.js';
 import { OpportunityReservation } from './reservations.js';
 import { BaseSearchRequest } from './search.js';
@@ -229,12 +229,15 @@ export type OpportunityUpdate = {
   };
 };
 
-export type PaymentSummary = {
+export type OpportunityPaymentSummary = {
   total: string;
   paid: string;
-  entries: DataRecord<Payment>[];
+  entries: DataRecord<OpportunityPayment>[];
 };
 
+/** @deprecated Renamed to {@link OpportunityPaymentSummary}. */
+export type PaymentSummary = OpportunityPaymentSummary;
+
 export type VehicleBffMetadata = {
   openOpportunities: number;
   otherRelatedVehicleIds: string[];
@@ -273,7 +276,7 @@ export type OpportunityBFF = {
   bids: DataRecord<Bid>[];
   quotes: DataRecord<Quote>[];
   activeQuote?: DataRecord<Quote>;
-  payments: PaymentSummary | undefined;
+  payments: OpportunityPaymentSummary | undefined;
   reservation?: DataRecord<OpportunityReservation>;
   tasks: DataRecord<Task>[];
   customer?: {

package/src/types/opportunity-payments.ts

@@ -0,0 +1,77 @@
+import { BaseEvent } from './internal-events.js';
+
+export enum OpportunityPaymentActions {
+  DELETE = 'delete',
+  EDIT = 'edit',
+}
+
+export const OPPORTUNITY_PAYMENT_NOTIFICATION_ORIGIN = 'opportunity-payment-notification';
+
+type BaseOpportunityPayment = {
+  opportunityId: string;
+  amount: string;
+  description?: string;
+  vehicleId: string;
+  organizationId: string;
+};
+
+export type NewOpportunityPayment = BaseOpportunityPayment & {
+  id?: undefined;
+  createdAt?: undefined;
+  createdBy?: undefined;
+  modifiedAt?: undefined;
+  modifiedBy?: undefined;
+  deletedAt?: undefined;
+  deletedBy?: undefined;
+  paidAt: string;
+};
+
+export type OpportunityPayment = BaseOpportunityPayment & {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  deletedAt?: string;
+  deletedBy?: string;
+  paidAt?: string;
+};
+
+export type OpportunityPaymentUpdate = {
+  description?: string;
+  amount?: string;
+  paidAt?: string;
+};
+
+export type OpportunityPaymentCreateEvent = {
+  payment: OpportunityPayment;
+  previousPayment?: undefined;
+  action: 'create';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+  branchId: string;
+};
+
+export type OpportunityPaymentUpdateEvent = {
+  payment: OpportunityPayment;
+  previousPayment: OpportunityPayment;
+  action: 'update';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+  branchId: string;
+};
+
+export type OpportunityPaymentDeleteEvent = {
+  payment?: undefined;
+  previousPayment: OpportunityPayment;
+  action: 'delete';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+  branchId: string;
+};
+
+export type OpportunityPaymentEvent = BaseEvent &
+  (OpportunityPaymentCreateEvent | OpportunityPaymentUpdateEvent | OpportunityPaymentDeleteEvent);

package/src/types/payments.ts

@@ -1,131 +1,29 @@
-import { BaseEvent } from './internal-events.js';
-import { SearchVehicle } from './vehicles.js';
-
-export enum PaymentActions {
-  DELETE = 'delete',
-  EDIT = 'edit',
-}
-
-export const PAYMENT_NOTIFICATION_ORIGIN = 'payment-notification';
-
-type BasePayment = {
-  opportunityId: string;
-  amount: string;
-  description?: string;
-  vehicleId: string;
-  organizationId: string;
-};
-
-export type NewPayment = BasePayment & {
-  id?: undefined;
-  createdAt?: undefined;
-  createdBy?: undefined;
-  modifiedAt?: undefined;
-  modifiedBy?: undefined;
-  deletedAt?: undefined;
-  deletedBy?: undefined;
-  paidAt: string;
-};
-
-export type Payment = BasePayment & {
-  id: string;
-  createdAt: string;
-  createdBy: string;
-  modifiedAt: string;
-  modifiedBy: string;
-  deletedAt?: string;
-  deletedBy?: string;
-  paidAt?: string;
-};
-
-export type PaymentUpdate = {
-  description?: string;
-  amount?: string;
-  paidAt?: string;
-};
-
-export type PaymentCreateEvent = {
-  payment: Payment;
-  previousPayment?: undefined;
-  action: 'create';
-  actionAt: string;
-  userId: string;
-  tenantId: string;
-  branchId: string;
-};
-
-export type PaymentUpdateEvent = {
-  payment: Payment;
-  previousPayment: Payment;
-  action: 'update';
-  actionAt: string;
-  userId: string;
-  tenantId: string;
-  branchId: string;
-};
-
-export type PaymentDeleteEvent = {
-  payment?: undefined;
-  previousPayment: Payment;
-  action: 'delete';
-  actionAt: string;
-  userId: string;
-  tenantId: string;
-  branchId: string;
-};
-
-export type PaymentEvent = BaseEvent &
-  (PaymentCreateEvent | PaymentUpdateEvent | PaymentDeleteEvent);
-
-export type NewVehiclePurchasePayment = {
-  vehicleId: string;
-  amount: string;
-  description?: string;
-  paidAt?: string;
-  paidBy?: string;
-};
-
-export type VehiclePurchasePayment = NewVehiclePurchasePayment & {
-  id: string;
-  createdBy: string;
-  createdAt: string;
-};
-
-export type VehiclePurchasePaymentBff = {
-  payment: VehiclePurchasePayment;
-  vehicle: SearchVehicle;
-};
-
-export type VehiclePurchasePaymentCreateEvent = {
-  payment: VehiclePurchasePayment;
-  previousPayment?: undefined;
-  action: 'create';
-  actionAt: string;
-  userId: string;
-  tenantId: string;
-};
-
-export type VehiclePurchasePaymentUpdateEvent = {
-  payment: VehiclePurchasePayment;
-  previousPayment: VehiclePurchasePayment;
-  action: 'update';
-  actionAt: string;
-  userId: string;
-  tenantId: string;
-};
-
-export type VehiclePurchasePaymentDeleteEvent = {
-  payment?: undefined;
-  previousPayment: VehiclePurchasePayment;
-  action: 'delete';
-  actionAt: string;
-  userId: string;
-  tenantId: string;
-};
-
-export type VehiclePurchasePaymentEvent = BaseEvent &
-  (
-    | VehiclePurchasePaymentCreateEvent
-    | VehiclePurchasePaymentUpdateEvent
-    | VehiclePurchasePaymentDeleteEvent
-  );
+/**
+ * @deprecated This module was split into `./opportunity-payments.js` (the generic "payment"
+ * entity, now called opportunity payment) and `./vehicle-purchase-payments.js`. It only
+ * re-exports the old names so consumers of the published SDK keep compiling; import from the
+ * new modules instead. Delete this file once bisondesk-client no longer imports it.
+ */
+
+export type {
+  NewOpportunityPayment as NewPayment,
+  OpportunityPayment as Payment,
+  OpportunityPaymentCreateEvent as PaymentCreateEvent,
+  OpportunityPaymentDeleteEvent as PaymentDeleteEvent,
+  OpportunityPaymentEvent as PaymentEvent,
+  OpportunityPaymentUpdate as PaymentUpdate,
+  OpportunityPaymentUpdateEvent as PaymentUpdateEvent,
+} from './opportunity-payments.js';
+export {
+  OPPORTUNITY_PAYMENT_NOTIFICATION_ORIGIN as PAYMENT_NOTIFICATION_ORIGIN,
+  OpportunityPaymentActions as PaymentActions,
+} from './opportunity-payments.js';
+export type {
+  NewVehiclePurchasePayment,
+  VehiclePurchasePayment,
+  VehiclePurchasePaymentBff,
+  VehiclePurchasePaymentCreateEvent,
+  VehiclePurchasePaymentDeleteEvent,
+  VehiclePurchasePaymentEvent,
+  VehiclePurchasePaymentUpdateEvent,
+} from './vehicle-purchase-payments.js';

package/src/types/vehicle-purchase-payments.ts

@@ -0,0 +1,58 @@
+import { BaseEvent } from './internal-events.js';
+import { SearchVehicle } from './vehicles.js';
+
+export const VEHICLE_PURCHASE_PAYMENT_ALLOWED_NOTIFICATION_ORIGIN =
+  'vehicle-purchase-payment-allowed-notification';
+
+export type NewVehiclePurchasePayment = {
+  vehicleId: string;
+  amount: string;
+  description?: string;
+  paidAt?: string;
+  paidBy?: string;
+};
+
+export type VehiclePurchasePayment = NewVehiclePurchasePayment & {
+  id: string;
+  createdBy: string;
+  createdAt: string;
+};
+
+export type VehiclePurchasePaymentBff = {
+  payment: VehiclePurchasePayment;
+  vehicle: SearchVehicle;
+};
+
+export type VehiclePurchasePaymentCreateEvent = {
+  payment: VehiclePurchasePayment;
+  previousPayment?: undefined;
+  action: 'create';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+export type VehiclePurchasePaymentUpdateEvent = {
+  payment: VehiclePurchasePayment;
+  previousPayment: VehiclePurchasePayment;
+  action: 'update';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+export type VehiclePurchasePaymentDeleteEvent = {
+  payment?: undefined;
+  previousPayment: VehiclePurchasePayment;
+  action: 'delete';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+export type VehiclePurchasePaymentEvent = BaseEvent &
+  (
+    | VehiclePurchasePaymentCreateEvent
+    | VehiclePurchasePaymentUpdateEvent
+    | VehiclePurchasePaymentDeleteEvent
+  );