@retailcrm/embed-ui-v1-contexts 0.9.23-alpha.2 → 0.9.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +83 -1
- package/bin/embed-ui-v1-contexts-mcp.mjs +10 -0
- package/bin/embed-ui-v1-contexts.mjs +587 -0
- package/dist/mcp/server.cjs +147 -0
- package/dist/mcp/server.d.ts +3 -0
- package/dist/mcp/server.js +129 -0
- package/dist/meta.json +3 -3
- package/docs/actions/index.json +10 -0
- package/docs/actions/order-card.yml +107 -0
- package/docs/contexts/customer-card-phone.yml +37 -0
- package/docs/contexts/customer-card.yml +59 -0
- package/docs/contexts/index.json +35 -0
- package/docs/contexts/order-card-settings.yml +221 -0
- package/docs/contexts/order-card.yml +815 -0
- package/docs/contexts/settings.yml +54 -0
- package/docs/contexts/user-current.yml +119 -0
- package/docs/custom-contexts/index.json +10 -0
- package/docs/custom-contexts/order.yml +65 -0
- package/docs/ru/CONCEPT.md +195 -10
- package/package.json +22 -5
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
"context": "order/card:settings"
|
|
2
|
+
"summary": "Readonly order card settings that describe form capabilities and order item editing rules."
|
|
3
|
+
"language": "en-GB"
|
|
4
|
+
"audience": "ai"
|
|
5
|
+
"public_import":
|
|
6
|
+
"usage_import": "import { useContext } from '@retailcrm/embed-ui-v1-contexts/remote/order/card-settings'"
|
|
7
|
+
"usage_call": "const orderSettings = useContext()"
|
|
8
|
+
"fields":
|
|
9
|
+
-
|
|
10
|
+
"name": "changePriceTypeByPriority"
|
|
11
|
+
"type": "boolean"
|
|
12
|
+
"readonly": true
|
|
13
|
+
"description": "Change price type for the order item when item quantity is changed"
|
|
14
|
+
"mutation":
|
|
15
|
+
"mode": "readonly"
|
|
16
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
17
|
+
"related_actions": []
|
|
18
|
+
"ai_notes": []
|
|
19
|
+
-
|
|
20
|
+
"name": "changePriceTypeIfUnavailable"
|
|
21
|
+
"type": "boolean"
|
|
22
|
+
"readonly": true
|
|
23
|
+
"description": "Change the price type for the product/service in the order, if the current type is not available"
|
|
24
|
+
"mutation":
|
|
25
|
+
"mode": "readonly"
|
|
26
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
27
|
+
"related_actions": []
|
|
28
|
+
"ai_notes": []
|
|
29
|
+
-
|
|
30
|
+
"name": "defaultUnit"
|
|
31
|
+
"type": "string|null"
|
|
32
|
+
"readonly": true
|
|
33
|
+
"description": "Default quantity unit of measurement"
|
|
34
|
+
"mutation":
|
|
35
|
+
"mode": "readonly"
|
|
36
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
37
|
+
"related_actions": []
|
|
38
|
+
"ai_notes": []
|
|
39
|
+
-
|
|
40
|
+
"name": "duplicatesAllowed"
|
|
41
|
+
"type": "boolean"
|
|
42
|
+
"readonly": true
|
|
43
|
+
"description": "Possibility of adding the same SKUs to the order as different items"
|
|
44
|
+
"mutation":
|
|
45
|
+
"mode": "readonly"
|
|
46
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
47
|
+
"related_actions": []
|
|
48
|
+
"ai_notes": []
|
|
49
|
+
-
|
|
50
|
+
"name": "quantityIsFractional"
|
|
51
|
+
"type": "boolean"
|
|
52
|
+
"readonly": true
|
|
53
|
+
"description": "Integer or fractional quantity of items"
|
|
54
|
+
"mutation":
|
|
55
|
+
"mode": "readonly"
|
|
56
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
57
|
+
"related_actions": []
|
|
58
|
+
"ai_notes":
|
|
59
|
+
- "Controls whether quantity inputs should allow fractional values."
|
|
60
|
+
-
|
|
61
|
+
"name": "priceEditable"
|
|
62
|
+
"type": "boolean"
|
|
63
|
+
"readonly": true
|
|
64
|
+
"description": "Ability to edit item prices"
|
|
65
|
+
"mutation":
|
|
66
|
+
"mode": "readonly"
|
|
67
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
68
|
+
"related_actions": []
|
|
69
|
+
"ai_notes":
|
|
70
|
+
- "Controls whether UI should allow changing item price."
|
|
71
|
+
-
|
|
72
|
+
"name": "productsRemoveAllowed"
|
|
73
|
+
"type": "boolean"
|
|
74
|
+
"readonly": true
|
|
75
|
+
"description": "Ability to delete items from the order"
|
|
76
|
+
"mutation":
|
|
77
|
+
"mode": "readonly"
|
|
78
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
79
|
+
"related_actions": []
|
|
80
|
+
"ai_notes":
|
|
81
|
+
- "Controls whether UI should allow removing items from the order."
|
|
82
|
+
-
|
|
83
|
+
"name": "productsMarkingEnabled"
|
|
84
|
+
"type": "boolean"
|
|
85
|
+
"readonly": true
|
|
86
|
+
"description": "Possibility of working with marked products"
|
|
87
|
+
"mutation":
|
|
88
|
+
"mode": "readonly"
|
|
89
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
90
|
+
"related_actions": []
|
|
91
|
+
"ai_notes": []
|
|
92
|
+
-
|
|
93
|
+
"name": "propertiesToShow.additional"
|
|
94
|
+
"type": "Array<string>"
|
|
95
|
+
"readonly": true
|
|
96
|
+
"description": "Additional product fields displayed in the product list"
|
|
97
|
+
"mutation":
|
|
98
|
+
"mode": "readonly"
|
|
99
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
100
|
+
"related_actions": []
|
|
101
|
+
"ai_notes": []
|
|
102
|
+
-
|
|
103
|
+
"name": "propertiesToShow.base"
|
|
104
|
+
"type": "Array<string>"
|
|
105
|
+
"readonly": true
|
|
106
|
+
"description": "Basic product fields displayed in the product list"
|
|
107
|
+
"mutation":
|
|
108
|
+
"mode": "readonly"
|
|
109
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
110
|
+
"related_actions": []
|
|
111
|
+
"ai_notes": []
|
|
112
|
+
-
|
|
113
|
+
"name": "purchasePriceEditable"
|
|
114
|
+
"type": "boolean"
|
|
115
|
+
"readonly": true
|
|
116
|
+
"description": "Ability to edit purchase prices in the product list"
|
|
117
|
+
"mutation":
|
|
118
|
+
"mode": "readonly"
|
|
119
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
120
|
+
"related_actions": []
|
|
121
|
+
"ai_notes": []
|
|
122
|
+
-
|
|
123
|
+
"name": "purchasePriceVisible"
|
|
124
|
+
"type": "boolean"
|
|
125
|
+
"readonly": true
|
|
126
|
+
"description": "Display purchase prices in the product list"
|
|
127
|
+
"mutation":
|
|
128
|
+
"mode": "readonly"
|
|
129
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
130
|
+
"related_actions": []
|
|
131
|
+
"ai_notes": []
|
|
132
|
+
-
|
|
133
|
+
"name": "reserveDeliveryNoteEditable"
|
|
134
|
+
"type": "boolean"
|
|
135
|
+
"readonly": true
|
|
136
|
+
"description": "Ability to edit delivery note number when reserving products"
|
|
137
|
+
"mutation":
|
|
138
|
+
"mode": "readonly"
|
|
139
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
140
|
+
"related_actions": []
|
|
141
|
+
"ai_notes": []
|
|
142
|
+
-
|
|
143
|
+
"name": "reserveInvoiceEditable"
|
|
144
|
+
"type": "boolean"
|
|
145
|
+
"readonly": true
|
|
146
|
+
"description": "Ability to edit invoice number when reserving products"
|
|
147
|
+
"mutation":
|
|
148
|
+
"mode": "readonly"
|
|
149
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
150
|
+
"related_actions": []
|
|
151
|
+
"ai_notes": []
|
|
152
|
+
-
|
|
153
|
+
"name": "reserveShipmentDateEditable"
|
|
154
|
+
"type": "boolean"
|
|
155
|
+
"readonly": true
|
|
156
|
+
"description": "Ability to edit shipment date when reserving products"
|
|
157
|
+
"mutation":
|
|
158
|
+
"mode": "readonly"
|
|
159
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
160
|
+
"related_actions": []
|
|
161
|
+
"ai_notes": []
|
|
162
|
+
-
|
|
163
|
+
"name": "reserveTelephonyEnabled"
|
|
164
|
+
"type": "boolean"
|
|
165
|
+
"readonly": true
|
|
166
|
+
"description": "Telephony availability when reserving products"
|
|
167
|
+
"mutation":
|
|
168
|
+
"mode": "readonly"
|
|
169
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
170
|
+
"related_actions": []
|
|
171
|
+
"ai_notes": []
|
|
172
|
+
-
|
|
173
|
+
"name": "showArticle"
|
|
174
|
+
"type": "boolean"
|
|
175
|
+
"readonly": true
|
|
176
|
+
"description": "Display SKU"
|
|
177
|
+
"mutation":
|
|
178
|
+
"mode": "readonly"
|
|
179
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
180
|
+
"related_actions": []
|
|
181
|
+
"ai_notes": []
|
|
182
|
+
-
|
|
183
|
+
"name": "showPriceTypes"
|
|
184
|
+
"type": "boolean"
|
|
185
|
+
"readonly": true
|
|
186
|
+
"description": "Work with price types"
|
|
187
|
+
"mutation":
|
|
188
|
+
"mode": "readonly"
|
|
189
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
190
|
+
"related_actions": []
|
|
191
|
+
"ai_notes":
|
|
192
|
+
- "Controls whether price type display and selection are relevant."
|
|
193
|
+
-
|
|
194
|
+
"name": "useStores"
|
|
195
|
+
"type": "boolean"
|
|
196
|
+
"readonly": true
|
|
197
|
+
"description": "Work with warehouses"
|
|
198
|
+
"mutation":
|
|
199
|
+
"mode": "readonly"
|
|
200
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
201
|
+
"related_actions": []
|
|
202
|
+
"ai_notes":
|
|
203
|
+
- "Signals that warehouse scenarios are enabled for the order form."
|
|
204
|
+
-
|
|
205
|
+
"name": "useReserve"
|
|
206
|
+
"type": "boolean"
|
|
207
|
+
"readonly": true
|
|
208
|
+
"description": "Work with reservations"
|
|
209
|
+
"mutation":
|
|
210
|
+
"mode": "readonly"
|
|
211
|
+
"notes": "Readonly context field; use it for reading and UI calculations."
|
|
212
|
+
"related_actions": []
|
|
213
|
+
"ai_notes":
|
|
214
|
+
- "Signals that reservation scenarios are enabled for the order form."
|
|
215
|
+
"field_groups": []
|
|
216
|
+
"types": []
|
|
217
|
+
"usage":
|
|
218
|
+
"import": "import { useContext } from '@retailcrm/embed-ui-v1-contexts/remote/order/card-settings'"
|
|
219
|
+
"call": "const orderSettings = useContext()"
|
|
220
|
+
"related_actions": []
|
|
221
|
+
"ai_notes": []
|