@umbraco-commerce/backoffice 14.0.0-rc2 → 14.0.0-rc3

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/types/umbraco-commerce-public.d.ts +450 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@umbraco-commerce/backoffice",
3
- "version": "14.0.0-rc2",
3
+ "version": "14.0.0-rc3",
4
4
  "type": "module",
5
5
  "types": "./types/umbraco-commerce-public.d.ts",
6
6
  "files": [
package/types/umbraco-commerce-public.d.ts CHANGED
@@ -4,16 +4,450 @@ import { ManifestBase } from '@umbraco-cms/backoffice/extension-api';
4
4
  import { ManifestElement } from '@umbraco-cms/backoffice/extension-api';
5
5
  import { ManifestElementAndApi } from '@umbraco-cms/backoffice/extension-api';
6
6
  import { ManifestKind } from '@umbraco-cms/backoffice/extension-api';
7
+ import { Observable } from '@umbraco-cms/backoffice/observable-api';
7
8
  import { TemplateResult } from 'lit-html';
8
9
  import { UmbApi } from '@umbraco-cms/backoffice/extension-api';
10
+ import { UmbContextBase } from '@umbraco-cms/backoffice/class-api';
11
+ import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
12
+ import { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
9
13
  import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
10
14
  import { UmbElement } from '@umbraco-cms/backoffice/element-api';
11
15
  import { UmbExtensionElementInitializer } from '@umbraco-cms/backoffice/extension-api';
12
16
  import { UmbPropertyEditorConfig } from '@umbraco-cms/backoffice/property-editor';
13
17
 
18
+ declare type AllowedCountryDto = {
19
+ country?: CountryDto | CountryNamedReferenceDto | CountryReferenceDto | null;
20
+ };
21
+
22
+ declare type AllowedCountryRegionDto = {
23
+ country?: CountryDto | CountryNamedReferenceDto | CountryReferenceDto | null;
24
+ region?: RegionDto | RegionNamedReferenceDto | RegionReferenceDto | null;
25
+ };
26
+
27
+ declare type CountryDto = {
28
+ id: string;
29
+ code: string;
30
+ name?: string | null;
31
+ store?: StoreBasicDto | StoreDto | StoreNamedReferenceDto | StoreReferenceDto | null;
32
+ defaultCurrency?: CurrencyDto | CurrencyNamedReferenceDto | CurrencyReferenceDto | null;
33
+ defaultPaymentMethod?: PaymentMethodDto | PaymentMethodNamedReferenceDto | PaymentMethodReferenceDto | PaymentMethodWithFeeDto | null;
34
+ defaultShippingMethod?: ShippingMethodDto | ShippingMethodNamedReferenceDto | ShippingMethodReferenceDto | ShippingMethodWithRatesDto | null;
35
+ regions?: Array<RegionDto | RegionNamedReferenceDto | RegionReferenceDto> | null;
36
+ sortOrder?: number | null;
37
+ };
38
+
39
+ declare type CountryNamedReferenceDto = {
40
+ id: string;
41
+ code: string;
42
+ name?: string | null;
43
+ };
44
+
45
+ declare type CountryReferenceDto = {
46
+ id: string;
47
+ code: string;
48
+ };
49
+
50
+ declare type CountryRegionTaxRateDto = {
51
+ country?: CountryDto | CountryNamedReferenceDto | CountryReferenceDto | null;
52
+ region?: RegionDto | RegionNamedReferenceDto | RegionReferenceDto | null;
53
+ taxRate?: number | null;
54
+ };
55
+
56
+ declare type CurrencyDto = {
57
+ id: string;
58
+ code: string;
59
+ name?: string | null;
60
+ store?: StoreBasicDto | StoreDto | StoreNamedReferenceDto | StoreReferenceDto | null;
61
+ culture?: string | null;
62
+ symbol?: string | null;
63
+ decimalPlaces?: number | null;
64
+ decimalSeparator?: string | null;
65
+ groupSeparator?: string | null;
66
+ formatTemplate?: string | null;
67
+ allowedCountries?: Array<AllowedCountryDto> | null;
68
+ sortOrder?: number | null;
69
+ };
70
+
71
+ declare type CurrencyNamedReferenceDto = {
72
+ id: string;
73
+ code: string;
74
+ name?: string | null;
75
+ };
76
+
77
+ declare type CurrencyReferenceDto = {
78
+ id: string;
79
+ code: string;
80
+ };
81
+
82
+ declare type DynamicRateShippingCalculationConfigDto = {
83
+ rangeProviderAlias?: string | null;
84
+ rates?: Array<DynamicShippingRateDto> | null;
85
+ };
86
+
87
+ declare type DynamicRateShippingCalculationConfigRequestDto = {
88
+ rangeProviderAlias?: string | null;
89
+ rates?: Array<DynamicShippingRateDto> | null;
90
+ };
91
+
92
+ declare type DynamicShippingRateDto = {
93
+ from?: unknown;
94
+ to?: unknown;
95
+ values?: Array<DynamicShippingRateValueDto> | null;
96
+ };
97
+
98
+ declare type DynamicShippingRateValueDto = {
99
+ rateProviderAlias?: string | null;
100
+ value?: unknown;
101
+ };
102
+
103
+ declare type EmailTemplateDto = {
104
+ id: string;
105
+ alias: string;
106
+ name?: string | null;
107
+ store?: StoreBasicDto | StoreDto | StoreNamedReferenceDto | StoreReferenceDto | null;
108
+ category: TemplateCategory;
109
+ subject?: string | null;
110
+ senderName?: string | null;
111
+ senderAddress?: string | null;
112
+ replyToAddresses?: Array<string> | null;
113
+ toAddresses?: Array<string> | null;
114
+ ccAddresses?: Array<string> | null;
115
+ bccAddresses?: Array<string> | null;
116
+ sendToCustomer?: boolean | null;
117
+ templateView?: string | null;
118
+ sortOrder?: number | null;
119
+ };
120
+
121
+ declare type EmailTemplateNamedReferenceDto = {
122
+ id: string;
123
+ alias: string;
124
+ name?: string | null;
125
+ };
126
+
127
+ declare type EmailTemplateReferenceDto = {
128
+ id: string;
129
+ alias: string;
130
+ };
131
+
132
+ declare type FixedRateShippingCalculationConfigDto = {
133
+ prices?: Array<ServicePriceDto> | null;
134
+ };
135
+
136
+ declare type FormattedPriceDto = {
137
+ withoutTax?: string | null;
138
+ tax?: string | null;
139
+ withTax?: string | null;
140
+ };
141
+
142
+ declare enum GiftCardActivationMethod {
143
+ MANUAL = "Manual",
144
+ AUTOMATIC = "Automatic",
145
+ ORDER_STATUS = "OrderStatus"
146
+ }
147
+
148
+ declare type LocationDto = {
149
+ id: string;
150
+ alias: string;
151
+ name?: string | null;
152
+ store?: StoreBasicDto | StoreDto | StoreNamedReferenceDto | StoreReferenceDto | null;
153
+ addressLine1?: string | null;
154
+ addressLine2?: string | null;
155
+ city?: string | null;
156
+ region?: string | null;
157
+ countryIsoCode?: string | null;
158
+ zipCode?: string | null;
159
+ type: LocationType;
160
+ sortOrder?: number | null;
161
+ };
162
+
163
+ declare type LocationNamedReferenceDto = {
164
+ id: string;
165
+ alias: string;
166
+ name?: string | null;
167
+ };
168
+
169
+ declare type LocationReferenceDto = {
170
+ id: string;
171
+ alias: string;
172
+ };
173
+
174
+ declare enum LocationType {
175
+ COMMERCIAL = "Commercial",
176
+ RESIDENTIAL = "Residential"
177
+ }
178
+
179
+ declare enum MeasurementSystem {
180
+ METRIC = "Metric",
181
+ IMPERIAL = "Imperial"
182
+ }
183
+
184
+ declare enum OrderRoundingMethod {
185
+ UNIT = "Unit",
186
+ LINE = "Line",
187
+ TOTAL = "Total"
188
+ }
189
+
190
+ declare type OrderStatusDto = {
191
+ id: string;
192
+ alias: string;
193
+ name?: string | null;
194
+ store?: StoreBasicDto | StoreDto | StoreNamedReferenceDto | StoreReferenceDto | null;
195
+ color?: string | null;
196
+ sortOrder?: number | null;
197
+ };
198
+
199
+ declare type OrderStatusNamedReferenceDto = {
200
+ id: string;
201
+ alias: string;
202
+ name?: string | null;
203
+ };
204
+
205
+ declare type OrderStatusReferenceDto = {
206
+ id: string;
207
+ alias: string;
208
+ };
209
+
210
+ declare type PaymentMethodDto = {
211
+ id: string;
212
+ alias: string;
213
+ name?: string | null;
214
+ store?: StoreBasicDto | StoreDto | StoreNamedReferenceDto | StoreReferenceDto | null;
215
+ sku?: string | null;
216
+ taxClass?: TaxClassDto | TaxClassNamedReferenceDto | TaxClassReferenceDto | null;
217
+ imageId?: string | null;
218
+ paymentProviderAlias?: string | null;
219
+ paymentProviderSettings?: Record<string, unknown> | null;
220
+ enabledFeatures?: PaymentProviderFeaturesDto | null;
221
+ allowedCountryRegions?: Array<AllowedCountryRegionDto> | null;
222
+ prices?: Array<ServicePriceDto> | null;
223
+ sortOrder?: number | null;
224
+ };
225
+
226
+ declare type PaymentMethodNamedReferenceDto = {
227
+ id: string;
228
+ alias: string;
229
+ name?: string | null;
230
+ };
231
+
232
+ declare type PaymentMethodReferenceDto = {
233
+ id: string;
234
+ alias: string;
235
+ };
236
+
237
+ declare type PaymentMethodWithFeeDto = {
238
+ id: string;
239
+ alias: string;
240
+ name?: string | null;
241
+ store?: StoreBasicDto | StoreDto | StoreNamedReferenceDto | StoreReferenceDto | null;
242
+ sku?: string | null;
243
+ taxClass?: TaxClassDto | TaxClassNamedReferenceDto | TaxClassReferenceDto | null;
244
+ imageId?: string | null;
245
+ paymentProviderAlias?: string | null;
246
+ paymentProviderSettings?: Record<string, unknown> | null;
247
+ enabledFeatures?: PaymentProviderFeaturesDto | null;
248
+ allowedCountryRegions?: Array<AllowedCountryRegionDto> | null;
249
+ prices?: Array<ServicePriceDto> | null;
250
+ sortOrder?: number | null;
251
+ fee?: PriceDto | null;
252
+ };
253
+
254
+ declare type PaymentProviderFeaturesDto = {
255
+ fetchPaymentStatus?: boolean | null;
256
+ cancelPayment?: boolean | null;
257
+ capturePayment?: boolean | null;
258
+ refundPayment?: boolean | null;
259
+ };
260
+
261
+ declare type PriceDto = {
262
+ currency?: CurrencyReferenceDto | null;
263
+ withoutTax?: number | null;
264
+ tax?: number | null;
265
+ withTax?: number | null;
266
+ formatted?: FormattedPriceDto | null;
267
+ };
268
+
269
+ declare type RealtimeRateShippingCalculationConfigDto = {
270
+ fixedPriceSurcharge?: Record<string, number | null> | null;
271
+ percentageSurcharge?: number | null;
272
+ rateCacheDuration?: number | null;
273
+ };
274
+
275
+ declare type RealtimeRateShippingCalculationConfigRequestDto = {
276
+ fixedPriceSurcharge?: Record<string, number | null> | null;
277
+ percentageSurcharge?: number | null;
278
+ rateCacheDuration?: number | null;
279
+ };
280
+
281
+ declare type RegionDto = {
282
+ id: string;
283
+ code: string;
284
+ name?: string | null;
285
+ store?: StoreBasicDto | StoreDto | StoreNamedReferenceDto | StoreReferenceDto | null;
286
+ defaultPaymentMethod?: PaymentMethodDto | PaymentMethodNamedReferenceDto | PaymentMethodReferenceDto | PaymentMethodWithFeeDto | null;
287
+ defaultShippingMethod?: ShippingMethodDto | ShippingMethodNamedReferenceDto | ShippingMethodReferenceDto | ShippingMethodWithRatesDto | null;
288
+ sortOrder?: number | null;
289
+ };
290
+
291
+ declare type RegionNamedReferenceDto = {
292
+ id: string;
293
+ code: string;
294
+ name?: string | null;
295
+ };
296
+
297
+ declare type RegionReferenceDto = {
298
+ id: string;
299
+ code: string;
300
+ };
301
+
302
+ declare type ServicePriceDto = {
303
+ currency?: CurrencyDto | CurrencyNamedReferenceDto | CurrencyReferenceDto | null;
304
+ country?: CountryDto | CountryNamedReferenceDto | CountryReferenceDto | null;
305
+ region?: RegionDto | RegionNamedReferenceDto | RegionReferenceDto | null;
306
+ value?: number | null;
307
+ };
308
+
309
+ declare type ShippingMethodDto = {
310
+ id: string;
311
+ alias: string;
312
+ name?: string | null;
313
+ store?: StoreBasicDto | StoreDto | StoreNamedReferenceDto | StoreReferenceDto | null;
314
+ sku?: string | null;
315
+ taxClass?: TaxClassDto | TaxClassNamedReferenceDto | TaxClassReferenceDto | null;
316
+ imageId?: string | null;
317
+ shippingProviderAlias?: string | null;
318
+ calculationMode?: string | null;
319
+ calculationConfig?: DynamicRateShippingCalculationConfigDto | DynamicRateShippingCalculationConfigRequestDto | FixedRateShippingCalculationConfigDto | RealtimeRateShippingCalculationConfigDto | RealtimeRateShippingCalculationConfigRequestDto | null;
320
+ shippingProviderSettings?: Record<string, unknown> | null;
321
+ allowedCountryRegions?: Array<AllowedCountryRegionDto> | null;
322
+ sortOrder?: number | null;
323
+ };
324
+
325
+ declare type ShippingMethodNamedReferenceDto = {
326
+ id: string;
327
+ alias: string;
328
+ name?: string | null;
329
+ };
330
+
331
+ declare type ShippingMethodReferenceDto = {
332
+ id: string;
333
+ alias: string;
334
+ };
335
+
336
+ declare type ShippingMethodWithRatesDto = {
337
+ id: string;
338
+ alias: string;
339
+ name?: string | null;
340
+ store?: StoreBasicDto | StoreDto | StoreNamedReferenceDto | StoreReferenceDto | null;
341
+ sku?: string | null;
342
+ taxClass?: TaxClassDto | TaxClassNamedReferenceDto | TaxClassReferenceDto | null;
343
+ imageId?: string | null;
344
+ shippingProviderAlias?: string | null;
345
+ calculationMode?: string | null;
346
+ calculationConfig?: DynamicRateShippingCalculationConfigDto | DynamicRateShippingCalculationConfigRequestDto | FixedRateShippingCalculationConfigDto | RealtimeRateShippingCalculationConfigDto | RealtimeRateShippingCalculationConfigRequestDto | null;
347
+ shippingProviderSettings?: Record<string, unknown> | null;
348
+ allowedCountryRegions?: Array<AllowedCountryRegionDto> | null;
349
+ sortOrder?: number | null;
350
+ rates?: Array<ShippingRateDto> | null;
351
+ };
352
+
353
+ declare type ShippingOptionDto = {
354
+ id?: string | null;
355
+ name?: string | null;
356
+ };
357
+
358
+ declare type ShippingRateDto = {
359
+ option?: ShippingOptionDto | null;
360
+ packageId?: string | null;
361
+ value?: PriceDto | null;
362
+ };
363
+
364
+ declare type StoreBasicDto = {
365
+ id: string;
366
+ alias: string;
367
+ name?: string | null;
368
+ measurementSystem: MeasurementSystem;
369
+ sortOrder?: number | null;
370
+ };
371
+
372
+ declare type StoreDto = {
373
+ id: string;
374
+ alias: string;
375
+ name?: string | null;
376
+ measurementSystem: MeasurementSystem;
377
+ sortOrder?: number | null;
378
+ baseCurrency?: CurrencyDto | CurrencyNamedReferenceDto | CurrencyReferenceDto | null;
379
+ defaultLocation?: LocationDto | LocationNamedReferenceDto | LocationReferenceDto | null;
380
+ defaultCountry?: CountryDto | CountryNamedReferenceDto | CountryReferenceDto | null;
381
+ defaultTaxClass?: TaxClassDto | TaxClassNamedReferenceDto | TaxClassReferenceDto | null;
382
+ defaultOrderStatus?: OrderStatusDto | OrderStatusNamedReferenceDto | OrderStatusReferenceDto | null;
383
+ errorOrderStatus?: OrderStatusDto | OrderStatusNamedReferenceDto | OrderStatusReferenceDto | null;
384
+ pricesIncludeTax?: boolean | null;
385
+ useCookies?: boolean | null;
386
+ cookieTimeout?: number | null;
387
+ confirmationEmailTemplate?: EmailTemplateDto | EmailTemplateNamedReferenceDto | EmailTemplateReferenceDto | null;
388
+ errorEmailTemplate?: EmailTemplateDto | EmailTemplateNamedReferenceDto | EmailTemplateReferenceDto | null;
389
+ cartNumberTemplate?: string | null;
390
+ orderNumberTemplate?: string | null;
391
+ orderRoundingMethod: OrderRoundingMethod;
392
+ productPropertyAliases?: string | null;
393
+ productUniquenessPropertyAliases?: string | null;
394
+ giftCardCodeLength?: number | null;
395
+ giftCardDaysValid?: number | null;
396
+ giftCardCodeTemplate?: string | null;
397
+ giftCardPropertyAliases?: string | null;
398
+ giftCardActivationMethod: GiftCardActivationMethod;
399
+ giftCardActivationOrderStatus?: OrderStatusDto | OrderStatusNamedReferenceDto | OrderStatusReferenceDto | null;
400
+ defaultGiftCardEmailTemplate?: EmailTemplateDto | EmailTemplateNamedReferenceDto | EmailTemplateReferenceDto | null;
401
+ allowedUsers?: Array<string> | null;
402
+ allowedUserRoles?: Array<string> | null;
403
+ };
404
+
405
+ declare type StoreNamedReferenceDto = {
406
+ id: string;
407
+ alias: string;
408
+ name?: string | null;
409
+ };
410
+
411
+ declare type StoreReferenceDto = {
412
+ id: string;
413
+ alias: string;
414
+ };
415
+
416
+ declare type TaxClassDto = {
417
+ id: string;
418
+ alias: string;
419
+ name?: string | null;
420
+ store?: StoreBasicDto | StoreDto | StoreNamedReferenceDto | StoreReferenceDto | null;
421
+ defaultTaxRate?: number | null;
422
+ countryRegionTaxRates?: Array<CountryRegionTaxRateDto> | null;
423
+ sortOrder?: number | null;
424
+ };
425
+
426
+ declare type TaxClassNamedReferenceDto = {
427
+ id: string;
428
+ alias: string;
429
+ name?: string | null;
430
+ };
431
+
432
+ declare type TaxClassReferenceDto = {
433
+ id: string;
434
+ alias: string;
435
+ };
436
+
437
+ declare enum TemplateCategory {
438
+ ORDER = "Order",
439
+ GIFT_CARD = "GiftCard",
440
+ DISCOUNT = "Discount",
441
+ CART = "Cart",
442
+ CUSTOM = "Custom"
443
+ }
444
+
14
445
  /** @public **/
15
446
  export declare const UC_ENTITY_QUICK_ACTION_DEFAULT_KIND_MANIFEST: UcDefaultManifestEntityQuickActionKind;
16
447
 
448
+ /** @public **/
449
+ export declare const UC_STORE_CONTEXT: UmbContextToken<UcStoreContext, UcStoreContext>;
450
+
17
451
  /** @public **/
18
452
  export declare type UcAnalyticsTimeframe = {
19
453
  dateRange: UcAnalyticsTimeframeRange;
@@ -76,7 +510,7 @@ export declare interface UcManifestOrderCollectionProperty extends UcManifestRes
76
510
  }
77
511
 
78
512
  /** @public **/
79
- export declare interface UcManifestOrderLineProperty extends ManifestBase {
513
+ export declare interface UcManifestOrderLineProperty extends UcManifestResolvableOrderProperty<UcMetaOrderLineProperty>, ManifestBase {
80
514
  type: 'ucOrderLineProperty';
81
515
  forEntityTypes?: Array<string>;
82
516
  meta: UcMetaOrderLineProperty;
@@ -131,8 +565,7 @@ export declare interface UcMetaOrderCollectionProperty extends UcMetaResolvableO
131
565
  }
132
566
 
133
567
  /** @public **/
134
- export declare interface UcMetaOrderLineProperty {
135
- propertyAlias: string;
568
+ export declare interface UcMetaOrderLineProperty extends UcMetaResolvableOrderProperty {
136
569
  readOnly?: boolean;
137
570
  showInOrderLineSummary?: boolean;
138
571
  summaryStyle?: "inline" | "table";
@@ -177,6 +610,17 @@ export declare interface UcMetaStoreMenuItem {
177
610
  selectable?: boolean;
178
611
  }
179
612
 
613
+ /** @public **/
614
+ export declare class UcStoreContext extends UmbContextBase<UcStoreContext> {
615
+ #private;
616
+ readonly store: Observable<UcStoreModel | undefined>;
617
+ readonly id: Observable<string | undefined>;
618
+ readonly name: Observable<string | null | undefined>;
619
+ constructor(host: UmbControllerHost);
620
+ /* Excluded from this release type: load */
621
+ getStore(): UcStoreModel | undefined;
622
+ }
623
+
180
624
  /** @public **/
181
625
  export declare class UcStoreMenuItemElement extends UcStoreMenuItemElementBase {
182
626
  #private;
@@ -197,4 +641,7 @@ export declare class UcStoreMenuItemElement extends UcStoreMenuItemElementBase {
197
641
  /** @public **/
198
642
  export declare const UcStoreMenuItemElementBase: HTMLElementConstructor<UmbElement> & typeof LitElement;
199
643
 
644
+ /** @public **/
645
+ export declare type UcStoreModel = (StoreDto);
646
+
200
647
  export { }