@dodobrands/pos-receipts-plugin-contracts 5.12.8

package/examples/example-6.json

@@ -0,0 +1,81 @@
+{
+	"CashFromCustomer": 0,
+	"CashRegister": {
+		"Number": "31",
+		"ShouldCalculateTax": true,
+		"UUId": "0022487FBA1EBC6511EBA824DC4AE652"
+	},
+	"Customer": {
+		"Email": "pochta@mail.ru",
+		"Identifiers": {
+			"NIP": "1231216692"
+		},
+		"Name": "Tom Riddle"
+	},
+	"Taxpayer": {
+		"IdentificationNumber": null
+	},
+	"Order": {
+		"CreateDate": "2021-05-06T10:54:14.9342604+03:00",
+		"Id": "0022487FBA1EBC6A11EBAE400521DF20",
+		"Number": "4",
+		"PaymentType": "BankCard",
+		"PaymentTypeEnum": 0,
+		"OrderSource": 2,
+		"Price": {
+			"Discount": 0,
+			"TotalPrice": 95
+		},
+		"DeliveryDate": "2021-05-06T11:54:14.9342604+03:00",
+		"OrderType": 3,
+		"Products": [
+			{
+				"AddedIngredients": [],
+				"Id": "000D3A240C71BE9A11E719BE2AD13D0D",
+				"Name": "Coca Cola Zero 500 ml",
+				"PricePerProduct": {
+					"Discount": 95,
+					"Price": 95,
+					"Taxes": [
+						{
+							"Rate": 20,
+							"Type": "VAT"
+						}
+					]
+				},
+				"Quantity": 1,
+				"RemovedIngredients": []
+			},
+			{
+				"AddedIngredients": [],
+				"Id": "000D3A23B0DC80DC11E7571ACB3BC29C",
+				"Name": "Fanta Orange 2 l",
+				"PricePerProduct": {
+					"Discount": 0,
+					"Price": 95,
+					"Taxes": [
+						{
+							"Rate": 20,
+							"Type": "VAT"
+						}
+					]
+				},
+				"Quantity": 1,
+				"RemovedIngredients": []
+			}
+		]
+	},
+	"Organization": {
+		"Address": "71-75 Shelton Street, London, WC2H 9JQ, United Kingdom",
+		"Name": "Yukon Ltd Limited",
+		"Requisites": {
+			"VAT": "123456",
+			"SOME-OTHER-REQ-1": "1166313070681",
+			"SOME-OTHER-REQ-2": ""
+		}
+	},
+	"Store": {
+		"Address": "Platform 8 7/4, Kings Cross Station, London, N1 9AP, United Kingdom"
+	},
+	"PreviousReceipts": []
+}

package/examples/example-7.json

@@ -0,0 +1,76 @@
+{
+	"CashFromCustomer": 0,
+	"CashRegister": {
+		"Number": "31",
+		"ShouldCalculateTax": true,
+		"UUId": "0022487FBA1EBC6511EBA824DC4AE652"
+	},
+	"Customer": {
+		"Email": "pochta@mail.ru",
+		"Identifiers": {
+			"NIP": "1231216692"
+		},
+		"Name": "Tom Riddle"
+	},
+	"Taxpayer": {
+		"IdentificationNumber": null
+	},
+	"Order": {
+		"CreateDate": "2021-05-06T10:59:23.7925516+03:00",
+		"Id": "0022487FBA1EBC6A11EBAE40E2659A1A",
+		"Number": "5",
+		"PaymentType": "Cash",
+		"PaymentTypeEnum": 0,
+		"OrderSource": 2,
+		"Price": {
+			"Discount": 10430,
+			"TotalPrice": 0
+		},
+		"DeliveryDate": "2021-05-06T11:59:23.7925516+03:00",
+		"OrderType": 3,
+		"Products": [
+			{
+				"AddedIngredients": [],
+				"Id": "000D3A240C71BE9A11E719BE2AB17F88",
+				"Name": "The Mighty Meats 14 \"",
+				"PricePerProduct": {
+					"Discount": 0,
+					"Price": 745,
+					"Taxes": []
+				},
+				"Quantity": 14,
+				"RemovedIngredients": []
+			},
+			{
+				"AddedIngredients": [],
+				"Id": "11EA5A11B53111A0CB4BC59232AF6200",
+				"Name": "Fanta Orange 1.5 l",
+				"PricePerProduct": {
+					"Discount": 249,
+					"Price": 249,
+					"Taxes": [
+						{
+							"Rate": 14,
+							"Type": "VAT"
+						}
+					]
+				},
+				"Quantity": 1,
+				"RemovedIngredients": []
+			}
+		]
+	},
+	"Organization": {
+		"Address": "71-75 Shelton Street, London, WC2H 9JQ, United Kingdom",
+		"Name": "Yukon Ltd Limited",
+		"Requisites": {
+			"VAT": "123456",
+			"SOME-OTHER-REQ-1": "1166313070681",
+			"SOME-OTHER-REQ-2": ""
+		}
+	},
+	"Store": {
+		"Address": "Platform 8 7/4, Kings Cross Station, London, N1 9AP, United Kingdom"
+	},
+	"PreviousReceipts": []
+}

package/examples/readme.md

@@ -0,0 +1,45 @@
+# Examples
+
+## Description of contract fields
+
+Most of the fields are described in the comments of the contract itself.
+
+- `Receipt`: is the root type passed when printing a receipt.
+- `Receipt.Organization.Requisites`: contains the requisites of the organization. This is a dictionary containing values: "requisite identifier" - "requisite value". The necessary requisites of the organization must be discussed.
+- `Receipt.PreviousReceipts`: is an array of records of previously printed receipts for this order. Used to identify reprints. At the first print, the array is empty.
+
+## Description of examples
+
+### example-1
+
+The order was paid in cash without change. There are three products in the order with different tax rates. 1 snack and 2 drinks.
+
+### example-2
+
+The order was paid in cash with a change. There are different types of pizzas in different quantities. Ingredients were removed from one pizza.
+
+### example-3
+
+The order was paid by card. The order contains a combo and one single pizza. Please note that although the type of pizza in the combo and outside the combo is the same (id: 000D3A39D824A82E11EA1CB2A6661ED2), their prices are different, because products in combo may be cheaper.
+
+### example-4
+
+Order with a discount of 500 on the total order amount.
+
+### example-5
+
+#### example-5.1
+
+Purchased three identical pizzas (id: 000D3A240C71BE9A11E719BE2AB25A5D). Additional ingredients were added to one. Two pizzas have a product discount of 100.
+
+#### example-5.2
+
+Request to reprint a receipt.
+
+### example-6
+
+Two drinks were purchased. One of them was received as a gift (100% discount).
+
+### example-7
+
+Pizza and drink were purchased. The drink was received as a gift. A 100% discount was applied to the total order amount.

package/package.json

@@ -0,0 +1,47 @@
+{
+	"name": "@dodobrands/pos-receipts-plugin-contracts",
+	"version": "5.12.8",
+	"type": "module",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/dodopizza/kiosk.git"
+	},
+	"license": "Apache-2.0",
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		"import": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js"
+		},
+		"require": {
+			"types": "./dist/index.d.cts",
+			"require": "./dist/index.cjs"
+		}
+	},
+	"files": [
+		"dist",
+		"examples",
+		"CHANGELOG.md"
+	],
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/",
+		"access": "public"
+	},
+	"scripts": {
+		"build": "tsup src/index.ts --format cjs,esm --dts --clean --sourcemap",
+		"lint": "eslint \"{**/*,*}.{ts,tsx,js,jsx,json,mjs,cjs}\"",
+		"lint:fix": "yarn lint --fix",
+		"publish": "yarn npm publish"
+	},
+	"devDependencies": {
+		"@dodobrands/pos-plugins-shared-models": "workspace:*",
+		"@dodopizza/eslint-plugin": "3.0.1",
+		"@dodopizza/ts-config": "1.0.1",
+		"eslint": "9.8.0",
+		"tsup": "8.2.4",
+		"typescript": "5.6.3",
+		"typescript-eslint": "8.15.0"
+	}
+}

package/readme.md

@@ -0,0 +1,18 @@
+# pos-receipts-plugin-contracts
+
+Public contracts for cash register plugins
+
+## Documentation
+
+Please use auto-generated documentation available [here](https://dodopizza.github.io/cashierapp/)
+
+## Creating plugins
+Start from the documentation related to [ICashRegister interface](\src\ICashRegister.ts)
+
+
+## Tech radar
+
+We at Dodo have expertize at the following [Tech Radar](https://radar.thoughtworks.com/?sheetId=https%3A%2F%2Fdocs.google.com%2Fspreadsheets%2Fd%2F15B0mJaxj8gdS4opGCsn42w3PeIAV0YCfVeEFzzcFe5w%2Fpub%2Foutput%3Dcsv%26format%3D%252FDec%2C%202022)
+and try to follow [Dodo NFRs](https://www.notion.so/dodobrands/Frontend-NFR-draft-535df248e84347d1b46147b8026a5250).
+
+We present it here as a recommendation for all new contributors so that we can provide better support in the future.