@dodobrands/pos-receipts-plugin-contracts 5.13.1 → 5.13.2

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";var e=Object.defineProperty;var d=Object.getOwnPropertyDescriptor;var l=Object.getOwnPropertyNames;var k=Object.prototype.hasOwnProperty;var h=(t,o)=>{for(var a in o)e(t,a,{get:o[a],enumerable:!0})},z=(t,o,a,m)=>{if(o&&typeof o=="object"||typeof o=="function")for(let r of l(o))!k.call(t,r)&&r!==a&&e(t,r,{get:()=>o[r],enumerable:!(m=d(o,r))||m.enumerable});return t};var R=t=>z(e({},"__esModule",{value:!0}),t);var v={};h(v,{Business:()=>i,DigitalReceiptNotificationPreference:()=>g,KnownCountryCodes:()=>p,OrderSource:()=>f,OrderType:()=>s,OwnerType:()=>n,PaymentType:()=>x});module.exports=R(v);var i=(t=>(t.DodoPizza="dodoPizza",t.Drinkit="drinkit",t.Doner42="doner42",t))(i||{}),p=(t=>(t[t.Belarus=112]="Belarus",t[t.Kazakhstan=398]="Kazakhstan",t[t.Russia=643]="Russia",t[t.Uzbekistan=860]="Uzbekistan",t[t.Kyrgyzstan=417]="Kyrgyzstan",t))(p||{}),n=(t=>(t[t.Resail=0]="Resail",t[t.OwnProduction=1]="OwnProduction",t[t.Service=2]="Service",t))(n||{});var s=(t=>(t[t.Delivery=1]="Delivery",t[t.Pickup=2]="Pickup",t[t.Stationary=3]="Stationary",t[t.PersonalFood=4]="PersonalFood",t[t.ShopWindowSupply=5]="ShopWindowSupply",t))(s||{}),f=(t=>(t[t.Telephone=0]="Telephone",t[t.Site=1]="Site",t[t.Restaurant=2]="Restaurant",t[t.DefectOrder=3]="DefectOrder",t[t.Mobile=4]="Mobile",t[t.Pizzeria=5]="Pizzeria",t[t.Aggregator=6]="Aggregator",t[t.Kiosk=7]="Kiosk",t))(f||{}),x=(t=>(t[t.Cash=0]="Cash",t[t.BankCard=1]="BankCard",t[t.InternetAcquiring=2]="InternetAcquiring",t[t.Aggregator=3]="Aggregator",t))(x||{});var g=(r=>(r.NotSpecified="NotSpecified",r.None="None",r.Email="Email",r.PhoneSms="PhoneSms",r))(g||{});0&&(module.exports={Business,DigitalReceiptNotificationPreference,KnownCountryCodes,OrderSource,OrderType,OwnerType,PaymentType});
+"use strict";var r=Object.defineProperty;var R=Object.getOwnPropertyDescriptor;var e=Object.getOwnPropertyNames;var N=Object.prototype.hasOwnProperty;var b=(a,t)=>{for(var o in t)r(a,o,{get:t[o],enumerable:!0})},A=(a,t,o,f)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of e(t))!N.call(a,i)&&i!==o&&r(a,i,{get:()=>t[i],enumerable:!(f=R(t,i))||f.enumerable});return a};var D=a=>A(r({},"__esModule",{value:!0}),a);var P={};b(P,{Business:()=>x,DigitalReceiptNotificationPreference:()=>z,KnownCountryCodes:()=>l,OrderSource:()=>p,OrderType:()=>m,OwnerType:()=>g,PaymentMode:()=>n,PaymentSource:()=>s,PaymentStatus:()=>k,PaymentType:()=>v,RefundSource:()=>h});module.exports=D(P);var x=(a=>(a.DodoPizza="dodoPizza",a.Drinkit="drinkit",a.Doner42="doner42",a))(x||{}),l=(a=>(a[a.Belarus=112]="Belarus",a[a.Kazakhstan=398]="Kazakhstan",a[a.Russia=643]="Russia",a[a.Uzbekistan=860]="Uzbekistan",a[a.Kyrgyzstan=417]="Kyrgyzstan",a))(l||{}),g=(a=>(a[a.Resail=0]="Resail",a[a.OwnProduction=1]="OwnProduction",a[a.Service=2]="Service",a))(g||{}),n=(a=>(a.Card="Card",a.QR="QR",a))(n||{}),s=(a=>(a[a.RestaurantCashier=0]="RestaurantCashier",a[a.Kiosk=1]="Kiosk",a))(s||{}),k=(a=>(a.NotFound="NotFound",a.PaymentPending="PaymentPending",a.PaymentCompleted="PaymentCompleted",a.RefundPending="RefundPending",a.RefundCompleted="RefundCompleted",a.NotNeeded="NotNeeded",a))(k||{}),h=(a=>(a.RestaurantCashier="RestaurantCashier",a.RefundJob="RefundJob",a.Kiosk="Kiosk",a))(h||{}),m=(a=>(a[a.Delivery=1]="Delivery",a[a.Pickup=2]="Pickup",a[a.Stationary=3]="Stationary",a[a.PersonalFood=4]="PersonalFood",a[a.ShopWindowSupply=5]="ShopWindowSupply",a))(m||{}),p=(a=>(a[a.Telephone=0]="Telephone",a[a.Site=1]="Site",a[a.Restaurant=2]="Restaurant",a[a.DefectOrder=3]="DefectOrder",a[a.Mobile=4]="Mobile",a[a.Pizzeria=5]="Pizzeria",a[a.Aggregator=6]="Aggregator",a[a.Kiosk=7]="Kiosk",a))(p||{}),v=(a=>(a[a.Cash=0]="Cash",a[a.BankCard=1]="BankCard",a[a.InternetAcquiring=2]="InternetAcquiring",a[a.Aggregator=3]="Aggregator",a))(v||{});var z=(i=>(i.NotSpecified="NotSpecified",i.None="None",i.Email="Email",i.PhoneSms="PhoneSms",i))(z||{});0&&(module.exports={Business,DigitalReceiptNotificationPreference,KnownCountryCodes,OrderSource,OrderType,OwnerType,PaymentMode,PaymentSource,PaymentStatus,PaymentType,RefundSource});

package/dist/index.d.cts

@@ -73,6 +73,11 @@ interface KyrgyzstanProductData {
     /** `product` — if entry is resold, `service` — if entry is prepared in-house. */
     entryType?: 'product' | 'service';
 }
+
+type Message = {
+    content: string;
+} & MessageMetadata;
+type MessageWith<T> = Message & T;
 type MessageMetadata = {
     area?: string;
 };
@@ -142,6 +147,11 @@ type OperationIdentifiers = TransactionIdIdentifier | RRNIdentifier | {
 
 type PaymentInfo = OperationIdentifiers;
 
+declare enum PaymentMode {
+    Card = "Card",
+    QR = "QR"
+}
+
 type QRIdType = 'qrId';
 type HTMLContentType = 'htmlContent';
 type QRIdData = {
@@ -164,6 +174,11 @@ type HTMLContentData = {
 type QRData = QRIdData | HTMLContentData;
 
 type TextSlipType = 'text';
+/**
+ * Represents the slip type for CARD payment request
+ * In the future it could be extended with other types like 'html' or 'pdf'
+ */
+type SlipType = TextSlipType;
 type TextSlipData = {
     type: TextSlipType;
     textLines: string[];
@@ -201,6 +216,10 @@ type CardPaymentResult = {
      */
     card: CardInfo | null;
 };
+/**
+ * Represents the result of a payment operation.
+ */
+type PaymentResult<T extends PaymentMode = PaymentMode.Card> = T extends PaymentMode.Card ? CardPaymentResult : T extends PaymentMode.QR ? QrPaymentResult : never;
 
 /**
  * The result of a payment operation for an order.
@@ -216,6 +235,10 @@ type CardRefundResult = BaseRefundResult & {
     slip: SlipData | null;
 };
 type QrRefundResult = BaseRefundResult;
+/**
+ * Represents the result of a refund operation.
+ */
+type RefundResult<T extends PaymentMode = PaymentMode.Card> = T extends PaymentMode.Card ? CardRefundResult : T extends PaymentMode.QR ? QrRefundResult : never;
 
 /**
  * The result of a refund operation for an order.
@@ -278,6 +301,8 @@ interface Receipt {
     Cashier?: Cashier;
     /** Url of the image to print on the receipt. */
     Image?: Image;
+    /** @internal */
+    IdempotencyKey: string;
 }
 interface Cashier {
     /** Cashier name */
@@ -727,4 +752,4 @@ declare enum DigitalReceiptNotificationPreference {
     PhoneSms = "PhoneSms"
 }
 
-export { type AddedIngredient, Business, type CashRegister, type CashRegisterSettings, type Cashier, type Country, type CountryIsoCode, type Customer, type DepositCashOptions, DigitalReceiptNotificationPreference, type DigitalReceiptView, type DigitalReceiptViewType, type Fields, type HandleRefundRequest, type HandleRefundRequestClear, type HandleSaleRequest, type HandleSaleRequestClear, type ICashRegister, type IDigitalReceipt, type Image, type InitializationOptions, type JobRefundInfo, type KazakhstanProductData, type KioskPaymentInfo, type KioskRefundInfo, KnownCountryCodes, type KyrgyzstanProductData, type Loyalty, type MakeZReportOptions, type MarkingCodes, type Money, type Order, type OrderPrice, OrderSource, OrderType, type Organization, OwnerType, PaymentType, type PreviousReceipt, type PrintParams, type PrintTextOptions, type PrintedFiscalReceipt, type PrintedNonFiscalReceipt, type PrintedReceipt, type PrintedRefundReceipt, type Product, type ProductPrice, type ProductSpecificData, type Receipt, type ReceiptPaymentInfo, type ReceiptRefundInfo, type RestaurantCashierPaymentInfo, type RestaurantCashierRefundInfo, type Store, type Tax, type Taxpayer, type UzbekistanProductData, type WithdrawCashOptions };
+export { type AddedIngredient, Business, type CardInfo, type CardPaymentResult, type CardRefundResult, type CashRegister, type CashRegisterSettings, type Cashier, type Country, type CountryIsoCode, type CreateScopeOptions, type Customer, type DepositCashOptions, DigitalReceiptNotificationPreference, type DigitalReceiptView, type DigitalReceiptViewType, type ErrorMessageMetadataWith, type Fields, type HTMLContentData, type HTMLContentType, type HandleRefundRequest, type HandleRefundRequestClear, type HandleSaleRequest, type HandleSaleRequestClear, type ICashRegister, type IDigitalReceipt, type ILogger, type Image, type InitializationOptions, type JobRefundInfo, type KazakhstanProductData, type KioskPaymentInfo, type KioskRefundInfo, KnownCountryCodes, type KyrgyzstanProductData, type Loyalty, type MakeZReportOptions, type MarkingCodes, type Message, type MessageMetadata, type MessageMetadataWith, type MessageWith, type Money, type OperationIdentifiers, type Order, type OrderPaymentResult, type OrderPrice, type OrderRefundResult, OrderSource, OrderType, type Organization, OwnerType, type PaymentInfo, PaymentMode, type PaymentProvider, type PaymentResult, PaymentSource, PaymentStatus, PaymentType, type PreviousReceipt, type PrintParams, type PrintTextOptions, type PrintedFiscalReceipt, type PrintedNonFiscalReceipt, type PrintedReceipt, type PrintedRefundReceipt, type Product, type ProductPrice, type ProductSpecificData, type QRData, type QRIdData, type QRIdType, type QrPaymentResult, type QrRefundResult, type Receipt, type ReceiptPaymentInfo, type ReceiptRefundInfo, type RefundInfo, type RefundResult, RefundSource, type RestaurantCashierPaymentInfo, type RestaurantCashierRefundInfo, type SlipData, type SlipType, type Store, type Tax, type Taxpayer, type TextSlipData, type TextSlipType, type UzbekistanProductData, type WithdrawCashOptions };

package/dist/index.d.ts

@@ -73,6 +73,11 @@ interface KyrgyzstanProductData {
     /** `product` — if entry is resold, `service` — if entry is prepared in-house. */
     entryType?: 'product' | 'service';
 }
+
+type Message = {
+    content: string;
+} & MessageMetadata;
+type MessageWith<T> = Message & T;
 type MessageMetadata = {
     area?: string;
 };
@@ -142,6 +147,11 @@ type OperationIdentifiers = TransactionIdIdentifier | RRNIdentifier | {
 
 type PaymentInfo = OperationIdentifiers;
 
+declare enum PaymentMode {
+    Card = "Card",
+    QR = "QR"
+}
+
 type QRIdType = 'qrId';
 type HTMLContentType = 'htmlContent';
 type QRIdData = {
@@ -164,6 +174,11 @@ type HTMLContentData = {
 type QRData = QRIdData | HTMLContentData;
 
 type TextSlipType = 'text';
+/**
+ * Represents the slip type for CARD payment request
+ * In the future it could be extended with other types like 'html' or 'pdf'
+ */
+type SlipType = TextSlipType;
 type TextSlipData = {
     type: TextSlipType;
     textLines: string[];
@@ -201,6 +216,10 @@ type CardPaymentResult = {
      */
     card: CardInfo | null;
 };
+/**
+ * Represents the result of a payment operation.
+ */
+type PaymentResult<T extends PaymentMode = PaymentMode.Card> = T extends PaymentMode.Card ? CardPaymentResult : T extends PaymentMode.QR ? QrPaymentResult : never;
 
 /**
  * The result of a payment operation for an order.
@@ -216,6 +235,10 @@ type CardRefundResult = BaseRefundResult & {
     slip: SlipData | null;
 };
 type QrRefundResult = BaseRefundResult;
+/**
+ * Represents the result of a refund operation.
+ */
+type RefundResult<T extends PaymentMode = PaymentMode.Card> = T extends PaymentMode.Card ? CardRefundResult : T extends PaymentMode.QR ? QrRefundResult : never;
 
 /**
  * The result of a refund operation for an order.
@@ -278,6 +301,8 @@ interface Receipt {
     Cashier?: Cashier;
     /** Url of the image to print on the receipt. */
     Image?: Image;
+    /** @internal */
+    IdempotencyKey: string;
 }
 interface Cashier {
     /** Cashier name */
@@ -727,4 +752,4 @@ declare enum DigitalReceiptNotificationPreference {
     PhoneSms = "PhoneSms"
 }
 
-export { type AddedIngredient, Business, type CashRegister, type CashRegisterSettings, type Cashier, type Country, type CountryIsoCode, type Customer, type DepositCashOptions, DigitalReceiptNotificationPreference, type DigitalReceiptView, type DigitalReceiptViewType, type Fields, type HandleRefundRequest, type HandleRefundRequestClear, type HandleSaleRequest, type HandleSaleRequestClear, type ICashRegister, type IDigitalReceipt, type Image, type InitializationOptions, type JobRefundInfo, type KazakhstanProductData, type KioskPaymentInfo, type KioskRefundInfo, KnownCountryCodes, type KyrgyzstanProductData, type Loyalty, type MakeZReportOptions, type MarkingCodes, type Money, type Order, type OrderPrice, OrderSource, OrderType, type Organization, OwnerType, PaymentType, type PreviousReceipt, type PrintParams, type PrintTextOptions, type PrintedFiscalReceipt, type PrintedNonFiscalReceipt, type PrintedReceipt, type PrintedRefundReceipt, type Product, type ProductPrice, type ProductSpecificData, type Receipt, type ReceiptPaymentInfo, type ReceiptRefundInfo, type RestaurantCashierPaymentInfo, type RestaurantCashierRefundInfo, type Store, type Tax, type Taxpayer, type UzbekistanProductData, type WithdrawCashOptions };
+export { type AddedIngredient, Business, type CardInfo, type CardPaymentResult, type CardRefundResult, type CashRegister, type CashRegisterSettings, type Cashier, type Country, type CountryIsoCode, type CreateScopeOptions, type Customer, type DepositCashOptions, DigitalReceiptNotificationPreference, type DigitalReceiptView, type DigitalReceiptViewType, type ErrorMessageMetadataWith, type Fields, type HTMLContentData, type HTMLContentType, type HandleRefundRequest, type HandleRefundRequestClear, type HandleSaleRequest, type HandleSaleRequestClear, type ICashRegister, type IDigitalReceipt, type ILogger, type Image, type InitializationOptions, type JobRefundInfo, type KazakhstanProductData, type KioskPaymentInfo, type KioskRefundInfo, KnownCountryCodes, type KyrgyzstanProductData, type Loyalty, type MakeZReportOptions, type MarkingCodes, type Message, type MessageMetadata, type MessageMetadataWith, type MessageWith, type Money, type OperationIdentifiers, type Order, type OrderPaymentResult, type OrderPrice, type OrderRefundResult, OrderSource, OrderType, type Organization, OwnerType, type PaymentInfo, PaymentMode, type PaymentProvider, type PaymentResult, PaymentSource, PaymentStatus, PaymentType, type PreviousReceipt, type PrintParams, type PrintTextOptions, type PrintedFiscalReceipt, type PrintedNonFiscalReceipt, type PrintedReceipt, type PrintedRefundReceipt, type Product, type ProductPrice, type ProductSpecificData, type QRData, type QRIdData, type QRIdType, type QrPaymentResult, type QrRefundResult, type Receipt, type ReceiptPaymentInfo, type ReceiptRefundInfo, type RefundInfo, type RefundResult, RefundSource, type RestaurantCashierPaymentInfo, type RestaurantCashierRefundInfo, type SlipData, type SlipType, type Store, type Tax, type Taxpayer, type TextSlipData, type TextSlipType, type UzbekistanProductData, type WithdrawCashOptions };

package/dist/index.js

@@ -1 +1 @@
-var o=(t=>(t.DodoPizza="dodoPizza",t.Drinkit="drinkit",t.Doner42="doner42",t))(o||{}),a=(t=>(t[t.Belarus=112]="Belarus",t[t.Kazakhstan=398]="Kazakhstan",t[t.Russia=643]="Russia",t[t.Uzbekistan=860]="Uzbekistan",t[t.Kyrgyzstan=417]="Kyrgyzstan",t))(a||{}),e=(t=>(t[t.Resail=0]="Resail",t[t.OwnProduction=1]="OwnProduction",t[t.Service=2]="Service",t))(e||{});var i=(t=>(t[t.Delivery=1]="Delivery",t[t.Pickup=2]="Pickup",t[t.Stationary=3]="Stationary",t[t.PersonalFood=4]="PersonalFood",t[t.ShopWindowSupply=5]="ShopWindowSupply",t))(i||{}),p=(t=>(t[t.Telephone=0]="Telephone",t[t.Site=1]="Site",t[t.Restaurant=2]="Restaurant",t[t.DefectOrder=3]="DefectOrder",t[t.Mobile=4]="Mobile",t[t.Pizzeria=5]="Pizzeria",t[t.Aggregator=6]="Aggregator",t[t.Kiosk=7]="Kiosk",t))(p||{}),n=(t=>(t[t.Cash=0]="Cash",t[t.BankCard=1]="BankCard",t[t.InternetAcquiring=2]="InternetAcquiring",t[t.Aggregator=3]="Aggregator",t))(n||{});var s=(r=>(r.NotSpecified="NotSpecified",r.None="None",r.Email="Email",r.PhoneSms="PhoneSms",r))(s||{});export{o as Business,s as DigitalReceiptNotificationPreference,a as KnownCountryCodes,p as OrderSource,i as OrderType,e as OwnerType,n as PaymentType};
+var t=(a=>(a.DodoPizza="dodoPizza",a.Drinkit="drinkit",a.Doner42="doner42",a))(t||{}),o=(a=>(a[a.Belarus=112]="Belarus",a[a.Kazakhstan=398]="Kazakhstan",a[a.Russia=643]="Russia",a[a.Uzbekistan=860]="Uzbekistan",a[a.Kyrgyzstan=417]="Kyrgyzstan",a))(o||{}),r=(a=>(a[a.Resail=0]="Resail",a[a.OwnProduction=1]="OwnProduction",a[a.Service=2]="Service",a))(r||{}),f=(a=>(a.Card="Card",a.QR="QR",a))(f||{}),x=(a=>(a[a.RestaurantCashier=0]="RestaurantCashier",a[a.Kiosk=1]="Kiosk",a))(x||{}),l=(a=>(a.NotFound="NotFound",a.PaymentPending="PaymentPending",a.PaymentCompleted="PaymentCompleted",a.RefundPending="RefundPending",a.RefundCompleted="RefundCompleted",a.NotNeeded="NotNeeded",a))(l||{}),g=(a=>(a.RestaurantCashier="RestaurantCashier",a.RefundJob="RefundJob",a.Kiosk="Kiosk",a))(g||{}),n=(a=>(a[a.Delivery=1]="Delivery",a[a.Pickup=2]="Pickup",a[a.Stationary=3]="Stationary",a[a.PersonalFood=4]="PersonalFood",a[a.ShopWindowSupply=5]="ShopWindowSupply",a))(n||{}),s=(a=>(a[a.Telephone=0]="Telephone",a[a.Site=1]="Site",a[a.Restaurant=2]="Restaurant",a[a.DefectOrder=3]="DefectOrder",a[a.Mobile=4]="Mobile",a[a.Pizzeria=5]="Pizzeria",a[a.Aggregator=6]="Aggregator",a[a.Kiosk=7]="Kiosk",a))(s||{}),k=(a=>(a[a.Cash=0]="Cash",a[a.BankCard=1]="BankCard",a[a.InternetAcquiring=2]="InternetAcquiring",a[a.Aggregator=3]="Aggregator",a))(k||{});var h=(i=>(i.NotSpecified="NotSpecified",i.None="None",i.Email="Email",i.PhoneSms="PhoneSms",i))(h||{});export{t as Business,h as DigitalReceiptNotificationPreference,o as KnownCountryCodes,s as OrderSource,n as OrderType,r as OwnerType,f as PaymentMode,x as PaymentSource,l as PaymentStatus,k as PaymentType,g as RefundSource};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@dodobrands/pos-receipts-plugin-contracts",
-	"version": "5.13.1",
+	"version": "5.13.2",
 	"type": "module",
 	"repository": {
 		"type": "git",