@retailcrm/embed-ui-v1-endpoint 0.9.21 → 0.9.22-alpha.1

package/docs/targets/order-card-common-before.yml

@@ -0,0 +1,51 @@
+target: "order/card:common.before"
+summary: >
+  Widget for the section with common data. It is placed in the full order form: Section start, right above the input fields.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "common.before"
+
+description: "Widget for the section with common data"
+location: "Section start, right above the input fields"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:common.before."
+  - "The widget belongs to the full order form and should appear at this location: Section start, right above the input fields."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-customer-after.yml

@@ -0,0 +1,51 @@
+target: "order/card:customer.after"
+summary: >
+  Widget for the section with customer data. It is placed in the full order form: Section end, right under the input fields.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "customer.after"
+
+description: "Widget for the section with customer data"
+location: "Section end, right under the input fields"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:customer.after."
+  - "The widget belongs to the full order form and should appear at this location: Section end, right under the input fields."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-customer-before.yml

@@ -0,0 +1,51 @@
+target: "order/card:customer.before"
+summary: >
+  Widget for the section with customer data. It is placed in the full order form: Section start, right above the input fields.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "customer.before"
+
+description: "Widget for the section with customer data"
+location: "Section start, right above the input fields"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:customer.before."
+  - "The widget belongs to the full order form and should appear at this location: Section start, right above the input fields."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-customer-email.yml

@@ -0,0 +1,51 @@
+target: "order/card:customer.email"
+summary: >
+  Widget for customer email input field. It is placed in the full order form: Right after the input field.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "customer.email"
+
+description: "Widget for customer email input field"
+location: "Right after the input field"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:customer.email."
+  - "The widget belongs to the full order form and should appear at this location: Right after the input field."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-customer-phone.yml

@@ -0,0 +1,51 @@
+target: "order/card:customer.phone"
+summary: >
+  Widget for customer phone input field. It is placed in the full order form: Right after the input field.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "customer.phone"
+
+description: "Widget for customer phone input field"
+location: "Right after the input field"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:customer.phone."
+  - "The widget belongs to the full order form and should appear at this location: Right after the input field."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-delivery-address.yml

@@ -0,0 +1,51 @@
+target: "order/card:delivery.address"
+summary: >
+  Widget for delivery address input field. It is placed in the full order form: Right under the input field.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "delivery.address"
+
+description: "Widget for delivery address input field"
+location: "Right under the input field"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:delivery.address."
+  - "The widget belongs to the full order form and should appear at this location: Right under the input field."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-delivery-after.yml

@@ -0,0 +1,51 @@
+target: "order/card:delivery.after"
+summary: >
+  Widget for the section with delivery data. It is placed in the full order form: Section end, right under the input fields.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "delivery.after"
+
+description: "Widget for the section with delivery data"
+location: "Section end, right under the input fields"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:delivery.after."
+  - "The widget belongs to the full order form and should appear at this location: Section end, right under the input fields."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-delivery-before.yml

@@ -0,0 +1,51 @@
+target: "order/card:delivery.before"
+summary: >
+  Widget for the section with delivery data. It is placed in the full order form: Section start, right above the input fields.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "delivery.before"
+
+description: "Widget for the section with delivery data"
+location: "Section start, right above the input fields"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:delivery.before."
+  - "The widget belongs to the full order form and should appear at this location: Section start, right above the input fields."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-dimensions-before.yml

@@ -0,0 +1,51 @@
+target: "order/card:dimensions.before"
+summary: >
+  Widget for the section with dimensions and weight. It is placed in the full order form: Section start, right above the input fields.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "dimensions.before"
+
+description: "Widget for the section with dimensions and weight"
+location: "Section start, right above the input fields"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:dimensions.before."
+  - "The widget belongs to the full order form and should appear at this location: Section start, right above the input fields."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-list-after.yml

@@ -0,0 +1,51 @@
+target: "order/card:list.after"
+summary: >
+  Widget for the list of ordered items. It is placed in the full order form: Section start, right under the list.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "list.after"
+
+description: "Widget for the list of ordered items"
+location: "Section start, right under the list"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:list.after."
+  - "The widget belongs to the full order form and should appear at this location: Section start, right under the list."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-list-before.yml

@@ -0,0 +1,51 @@
+target: "order/card:list.before"
+summary: >
+  Widget for the list of ordered items. It is placed in the full order form: Section start, right above the input fields.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "list.before"
+
+description: "Widget for the list of ordered items"
+location: "Section start, right above the input fields"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:list.before."
+  - "The widget belongs to the full order form and should appear at this location: Section start, right above the input fields."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-payment-before.yml

@@ -0,0 +1,51 @@
+target: "order/card:payment.before"
+summary: >
+  Widget for the section with payment data. It is placed in the full order form: Section start, right above the input fields.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "payment.before"
+
+description: "Widget for the section with payment data"
+location: "Section start, right above the input fields"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:payment.before."
+  - "The widget belongs to the full order form and should appear at this location: Section start, right above the input fields."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."

package/docs/targets/order-card-store-before.yml

@@ -0,0 +1,51 @@
+target: "order/card:store.before"
+summary: >
+  Widget for the section with warehouse data. It is placed in the full order form: Section start, right above the input fields.
+language: en-GB
+audience: ai
+
+public_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/common"
+  named:
+    - targets
+    - TargetName
+
+runner_import:
+  from: "@retailcrm/embed-ui-v1-endpoint/remote/widgets"
+  named:
+    - defineWidgetRunner
+    - defineMultiRunner
+
+page:
+  id: "order/card"
+  label: "full order form"
+  area: "store.before"
+
+description: "Widget for the section with warehouse data"
+location: "Section start, right above the input fields"
+
+target_config:
+  contexts:
+    - "order/card"
+    - "order/card:settings"
+    - "user/current"
+    - "settings"
+  custom_contexts:
+    - "order"
+  action_scopes:
+    - "order/card"
+
+use_when:
+  - "Place a widget exactly at order/card:store.before."
+  - "The widget belongs to the full order form and should appear at this location: Section start, right above the input fields."
+  - "The widget can work with the contexts listed in target_config.contexts."
+
+avoid_when:
+  - "The widget belongs to a different page, section, or field-level insertion point."
+  - "The widget requires contexts, custom contexts, or action scopes that are not listed in target_config."
+
+ai_notes:
+  - "Use the target id as the runner registration key."
+  - "Use targets[target].contexts as the source of truth for context availability."
+  - "Do not duplicate target context lists in generated widget code."
+  - "Order card and chat order form targets share the same order form data contract."