@vendure/docs 0.0.0-202601211535 → 0.0.0-202601211551

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 (100) hide show
  1. package/docs/guides/extending-the-dashboard/migration/index.mdx +1 -1
  2. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +3 -3
  3. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
  4. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  5. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  6. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
  7. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
  8. package/docs/reference/admin-ui-api/services/data-service.mdx +3 -3
  9. package/docs/reference/admin-ui-api/services/modal-service.mdx +2 -2
  10. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
  11. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +2 -2
  12. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
  13. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
  14. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  15. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
  16. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +1 -1
  17. package/docs/reference/dashboard/detail-views/detail-page.mdx +1 -1
  18. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +1 -1
  19. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
  20. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  21. package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
  22. package/docs/reference/dashboard/list-views/list-page.mdx +1 -1
  23. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +1 -1
  24. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +1 -1
  25. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +1 -1
  26. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
  27. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  28. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +1 -1
  29. package/docs/reference/typescript-api/configuration/vendure-config.mdx +1 -1
  30. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  31. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  32. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
  33. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +1 -1
  34. package/docs/reference/typescript-api/entities/promotion.mdx +1 -1
  35. package/docs/reference/typescript-api/events/event-bus.mdx +1 -1
  36. package/docs/reference/typescript-api/events/event-types.mdx +29 -29
  37. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -3
  38. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  39. package/docs/reference/typescript-api/import-export/import-parser.mdx +1 -1
  40. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -2
  41. package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
  42. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
  43. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  44. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +5 -5
  45. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  46. package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
  47. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +2 -2
  48. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +3 -3
  49. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +2 -2
  50. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  51. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  52. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  53. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  54. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  55. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +5 -5
  56. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
  57. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
  58. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  59. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  60. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  61. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  62. package/docs/reference/typescript-api/promotions/promotion-action.mdx +11 -11
  63. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +2 -2
  64. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  65. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +3 -3
  66. package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
  67. package/docs/reference/typescript-api/services/asset-service.mdx +1 -1
  68. package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
  69. package/docs/reference/typescript-api/services/collection-service.mdx +2 -2
  70. package/docs/reference/typescript-api/services/country-service.mdx +1 -1
  71. package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
  72. package/docs/reference/typescript-api/services/customer-service.mdx +5 -5
  73. package/docs/reference/typescript-api/services/facet-service.mdx +2 -2
  74. package/docs/reference/typescript-api/services/facet-value-service.mdx +2 -2
  75. package/docs/reference/typescript-api/services/history-service.mdx +2 -2
  76. package/docs/reference/typescript-api/services/order-service.mdx +18 -18
  77. package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
  78. package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
  79. package/docs/reference/typescript-api/services/product-service.mdx +2 -2
  80. package/docs/reference/typescript-api/services/product-variant-service.mdx +3 -3
  81. package/docs/reference/typescript-api/services/promotion-service.mdx +3 -3
  82. package/docs/reference/typescript-api/services/province-service.mdx +1 -1
  83. package/docs/reference/typescript-api/services/role-service.mdx +1 -1
  84. package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
  85. package/docs/reference/typescript-api/services/settings-store-service.mdx +6 -6
  86. package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
  87. package/docs/reference/typescript-api/services/stock-location-service.mdx +1 -1
  88. package/docs/reference/typescript-api/services/stock-movement-service.mdx +1 -1
  89. package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
  90. package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
  91. package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
  92. package/docs/reference/typescript-api/services/user-service.mdx +1 -1
  93. package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
  94. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
  95. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
  96. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  97. package/docs/reference/typescript-api/state-machine/fsm.mdx +1 -1
  98. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
  99. package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
  100. package/package.json +1 -1
@@ -21,12 +21,12 @@ interface ShippingOptions {
21
21
 
22
22
  ### shippingEligibilityCheckers
23
23
 
24
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker'>ShippingEligibilityChecker</a><any>>`} />
24
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker'>ShippingEligibilityChecker</a>`<any>`>`} />
25
25
 
26
26
  An array of available ShippingEligibilityCheckers for use in configuring ShippingMethods
27
27
  ### shippingCalculators
28
28
 
29
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculator'>ShippingCalculator</a><any>>`} />
29
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculator'>ShippingCalculator</a>`<any>`>`} />
30
30
 
31
31
  An array of available ShippingCalculators for use in configuring ShippingMethods
32
32
  ### shippingLineAssignmentStrategy
@@ -38,19 +38,19 @@ This allows you to set multiple shipping methods for a single order, each assign
38
38
  OrderLines.
39
39
  ### customFulfillmentProcess
40
40
 
41
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a><any>>`} />
41
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a>`<any>`>`} />
42
42
 
43
43
  Allows the definition of custom states and transition logic for the fulfillment process state machine.
44
44
  Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> interface.
45
45
  ### process
46
46
 
47
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a><any>>`} default={`<a href='/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess'>defaultFulfillmentProcess</a>`} since="2.0.0" />
47
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a>`<any>`>`} default={`<a href='/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess'>defaultFulfillmentProcess</a>`} since="2.0.0" />
48
48
 
49
49
  Allows the definition of custom states and transition logic for the fulfillment process state machine.
50
50
  Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> interface.
51
51
  ### fulfillmentHandlers
52
52
 
53
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler'>FulfillmentHandler</a><any>>`} />
53
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler'>FulfillmentHandler</a>`<any>`>`} />
54
54
 
55
55
  An array of available FulfillmentHandlers.
56
56
 
@@ -23,7 +23,7 @@ class FSM<T extends string, Data = any> {
23
23
 
24
24
  ### constructor
25
25
 
26
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a><T, Data>, initialState: T) => FSM`} />
26
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a>`<T, Data>`, initialState: T) => FSM`} />
27
27
 
28
28
 
29
29
  ### initialState
@@ -19,13 +19,13 @@ interface StateMachineConfig<T extends string, Data = undefined> {
19
19
 
20
20
  ### transitions
21
21
 
22
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><T>`} />
22
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<T>``} />
23
23
 
24
24
  Defines the available states of the state machine as well as the permitted
25
25
  transitions from one state to another.
26
26
  ### onTransitionStart
27
27
 
28
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><T, Data>`} />
28
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<T, Data>``} />
29
29
 
30
30
  Called before a transition takes place. If the function resolves to `false` or a string, then the transition
31
31
  will be cancelled. In the case of a string, the string (error message) will be forwarded to the onError handler.
@@ -34,12 +34,12 @@ If this function returns a value resolving to `true` or `void` (no return value)
34
34
  will be permitted.
35
35
  ### onTransitionEnd
36
36
 
37
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><T, Data>`} />
37
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<T, Data>``} />
38
38
 
39
39
  Called after a transition has taken place.
40
40
  ### onError
41
41
 
42
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><T>`} />
42
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<T>``} />
43
43
 
44
44
  Called when a transition is prevented and the `onTransitionStart` handler has returned an
45
45
  error message.
@@ -18,5 +18,5 @@ Parameters
18
18
 
19
19
  ### initializer
20
20
 
21
- <MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/testing/test-db-initializer#testdbinitializer'>TestDbInitializer</a><any>`} />
21
+ <MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/testing/test-db-initializer#testdbinitializer'>TestDbInitializer</a>`<any>``} />
22
22
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vendure/docs",
3
- "version": "0.0.0-202601211535",
3
+ "version": "0.0.0-202601211551",
4
4
  "type": "module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",