Hyvä

https://docs.hyva.io/
Admin
Hyvä is a modern Magento 2 frontend framework that provides a complete alternative to traditional...
Tokens:977,558
Snippets:9,311
Trust Score:10
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install Media Optimization via Composer and Run Setup Upgrade

Source: https://docs.hyva.io/hyva-commerce/features/media-optimization/installation.html

Install the Media Optimization module via Composer and run the Magento setup upgrade to apply the module's database and configuration changes.

```bash
composer require hyva-themes/commerce-module-media-optimization

```

```bash
bin/magento setup:upgrade

```

--------------------------------

### Run setup upgrade

Source: https://docs.hyva.io/hyva-checkout/getting-started/index.html

Execute this command to run the Magento setup upgrade, which is a required step after installing the Hyvä Checkout package.

```bash
bin/magento setup:upgrade
```

--------------------------------

### Example di.xml path for CSP routes

Source: https://docs.hyva.io/hyva-commerce/features/cms/extending-for-other-content-types.html

This is the file path to an example of the di.xml configuration for CSP frame policies, as referenced in the guide.

```text
vendor/hyva-themes/commerce-module-cms/src/magento-cms/etc/adminhtml/di.xml

```

--------------------------------

### Example Path: vendor/hyva-themes/commerce-module-cms/src/liveview-editor/etc/adminhtml/di.xml

Source: https://docs.hyva.io/hyva-commerce/features/cms/adding-assets-to-liveview-editor.html

The path to an example di.xml file that demonstrates the allowedAssets configuration.

```text
vendor/hyva-themes/commerce-module-cms/src/liveview-editor/etc/adminhtml/di.xml

```

--------------------------------

### Install magento2-base-layout-reset module via composer and bin/magento

Source: https://docs.hyva.io/hyva-themes/advanced-topics/generated-base-layout-resets.html

Explicitly installs the module, for example to upgrade a custom Hyvä base theme. Requires running composer require, module:enable, and setup:upgrade.

```bash
composer require hyva-themes/magento2-base-layout-reset
bin/magento module:enable Hyva_BaseLayoutReset
bin/magento setup:upgrade

```

--------------------------------

### composer.json repositories section for private-packagist

Source: https://docs.hyva.io/hyva-themes/faqs/configuring-packagist-and-gitlab.html

Example of the repositories section in composer.json that should be present when using packagist.com. If this record is missing, follow the getting started documentation.

```json
"repositories": {
    "private-packagist": {
        "type": "composer",
        "url": "https://hyva-themes.repo.packagist.com/yourProjectName/"
    },

```

--------------------------------

### ProviderInterface process() input/output example

Source: https://docs.hyva.io/hyva-themes/ai/features-providers/integration-guide.html

Shows the expected input structure for process() and the required output format with a 'responses' key.

```php
<?php
declare(strict_types=1);

// Input
$data = [
    'messages' => [
        ['messages' => [
            ['role' => 'system', 'content' => '...'],
            ['role' => 'user', 'content' => '...']
        ]]
    ]
];

// Output - must have 'responses' key
return ['responses' => ['Generated text here']];

```

--------------------------------

### composer.json git repository entry for gitlab.hyva.io

Source: https://docs.hyva.io/hyva-themes/faqs/configuring-packagist-and-gitlab.html

Example of a git repository entry in composer.json that references gitlab.hyva.io. Remove all such references when moving to packagist.com, then delete composer.lock and follow the getting started instructions.

```json
"hyva-themes/magento2-theme-module": {
    "type": "git",
    "url": "git@gitlab.hyva.io:hyva-themes/magento2-theme-module.git"
},

```

--------------------------------

### Install Product Recommendations metapackage

Source: https://docs.hyva.io/hyva-enterprise/getting-started/index.html

Run these Composer commands to install the Product Recommendations metapackage for Adobe Sensei Product Recommendations compatibility.

```bash
composer require hyva-themes/magento2-hyva-enterprise-product-recommendations
bin/magento setup:upgrade
```

--------------------------------

### Install Hyvä Payment Icons via Composer and setup:upgrade

Source: https://docs.hyva.io/hyva-themes/view-utilities/hyva-svg-icon-modules/payment-icons.html

Install the package and run the Magento setup upgrade command. Requires a Hyvä theme license.

```bash
composer require hyva-themes/magento2-payment-icons
bin/magento setup:upgrade
```

--------------------------------

### Install Admin Theme with Composer and Setup Upgrade

Source: https://docs.hyva.io/hyva-commerce/features/admin-theme/installation.html

Install the Hyvä Commerce Admin Theme module via Composer and run the Magento setup upgrade to apply the module changes.

```bash
composer require hyva-themes/commerce-theme-adminhtml

```

```bash
bin/magento setup:upgrade

```

--------------------------------

### Deploy Koti sample data on a fresh install

Source: https://docs.hyva.io/hyva-themes/getting-started/sample-data.html

Use these commands to deploy Koti sample data when no Luma sample data is present.

```bash
bin/magento hyva:sampledata:deploy
bin/magento setup:upgrade
```

--------------------------------

### Install Mirasvit POS bridge

Source: https://docs.hyva.io/hyva-pos/pro/bridge-modules.html

Install the Mirasvit bridge proof of concept. Enables the store credit and rewards modules, then runs setup:upgrade. The bridge has never been tested against Mirasvit's own extensions.

```bash
composer require hyva-themes/magento2-hyva-pos-mirasvit
bin/magento module:enable Hyva_PosMirasvitStoreCredit Hyva_PosMirasvitRewards
bin/magento setup:upgrade
```

--------------------------------

### Install AI providers metapackage from Packagist

Source: https://docs.hyva.io/hyva-themes/ai/features-providers/index.html

Use Composer to install the hyva-themes/magento2-ai-providers metapackage from Packagist. After installation, run bin/magento setup:upgrade.

```bash
composer require hyva-themes/magento2-ai-providers

```

```bash
bin/magento setup:upgrade

```

--------------------------------

### Install Form Builder beta with CMS dependency

Source: https://docs.hyva.io/hyva-commerce/faqs/installing-beta-releases.html

Installs both the CMS beta and the Form Builder beta together, then runs setup:upgrade. The CMS beta is required as a base.

```bash
composer require hyva-themes/commerce-module-cms:1.3.0-beta2 hyva-themes/commerce-module-form-builder:0.1.0
bin/magento setup:upgrade

```

--------------------------------

### Get Balances Response Example for GET /V1/pos/credits/balance/:customerId

Source: https://docs.hyva.io/hyva-pos/devdocs/api/credits.html

Example response from the Get Balances endpoint. Shows one entry per credit with currency-based credits leaving points fields null and point-based credits carrying balance in points along with conversion fields.

```json
[
  {
    "type": "store_credit",
    "provider": "adobe_commerce",
    "label": "Store Credit",
    "balance": 25.0,
    "currency": "EUR",
    "code": null,
    "is_redeemable": true,
    "currency_value": null,
    "points_per_currency": null,
    "expires_at": null,
    "details": null
  },
  {
    "type": "loyalty_points",
    "provider": "adobe_commerce",
    "label": "Reward Points",
    "balance": 480.0,
    "currency": null,
    "code": null,
    "is_redeemable": true,
    "currency_value": 4.8,
    "points_per_currency": 100.0,
    "expires_at": "2026-12-31T00:00:00+00:00",
    "details": null
  }
]
```

--------------------------------

### Install Image Editor with Composer

Source: https://docs.hyva.io/hyva-commerce/features/image-editor/installation.html

Install the Image Editor module via Composer and run the Magento setup upgrade. This is the recommended installation method for most users.

```bash
composer require hyva-themes/commerce-module-image-editor

```

```bash
bin/magento setup:upgrade

```

--------------------------------

### Install Live Search metapackage

Source: https://docs.hyva.io/hyva-enterprise/getting-started/index.html

Run these Composer commands to install the Live Search metapackage for Adobe Sensei Live Search compatibility.

```bash
composer require hyva-themes/magento2-hyva-enterprise-live-search
bin/magento setup:upgrade
```

--------------------------------

### Install Koti alongside Luma sample data

Source: https://docs.hyva.io/hyva-themes/getting-started/sample-data.html

Use the --keep-luma flag to install Koti on a separate website while keeping the Luma store untouched.

```bash
bin/magento hyva:sampledata:deploy --keep-luma
bin/magento setup:upgrade
```

--------------------------------

### Start the minifier daemon

Source: https://docs.hyva.io/hyva-themes/performance/hyva-minification-readme.html

Commands to install Node dependencies and start the daemon. The daemon listens on 127.0.0.1:3100 by default.

```bash
cd vendor/hyva-themes/magento2-minification/node
npm install --ignore-scripts
npm run minifier-daemon

```

--------------------------------

### Install via Composer

Source: https://docs.hyva.io/hyva-themes/writing-code/csp/csp-in-context-payment-buttons.html

Run this command to install the CSP in-context payment module via Composer.

```bash
composer require hyva-themes/magento2-csp-in-context-payment
```

--------------------------------

### Install base AI framework module from Packagist

Source: https://docs.hyva.io/hyva-themes/ai/features-providers/index.html

Use Composer to install the hyva-themes/magento2-module-ai base framework module from Packagist. After installation, run bin/magento setup:upgrade.

```bash
composer require hyva-themes/magento2-module-ai

```

```bash
bin/magento setup:upgrade

```

--------------------------------

### Install Hyva_MagentoLiveSearch via Composer

Source: https://docs.hyva.io/hyva-enterprise/devdocs/sensei/live-search/index.html

Install the Hyva Live Search module using Composer and run the setup upgrade command. This is required to enable the module after installation.

```bash
composer require hyva-themes/magento2-ee-magento-live-search
bin/magento setup:upgrade

```

--------------------------------

### Live Chat Facade Implementation

Source: https://docs.hyva.io/hyva-themes/writing-code/patterns/loading-external-javascript.html

This example demonstrates creating a button facade that triggers the loading of a live chat script upon user interaction. The button must be styled to reserve space and match the provider's expected DOM structure.

```html
<button data-role="init-live-chat"
        class="btn btn-primary /* add styles here to reserve space, recreate button display and avoid layout shifts */">
    <?= $escaper->escapeHtml(__('Click to chat!')) ?>
</button>

<script>
    const liveChatButton = document.querySelector('[data-role="init-live-chat"]');
    liveChatButton.addEventListener('click', () => {
        // Implement live chat 
        // This may be a script include or embed code, depending on the vendor

        // Programmatically trigger 'click' of actual live chat button to open panel/window (but ensure live chat library has loaded first)
        liveChatButton.click();
    }, {once: true});
</script>
```

--------------------------------

### Run npm ci and npm run build with --prefix

Source: https://docs.hyva.io/hyva-themes/working-with-tailwindcss/generating-css.html

Run npm commands from any directory by passing the --prefix argument with the path to the theme's web/tailwind folder. The first command performs a clean install; the second builds the production CSS.

```bash
npm --prefix path/to/project/app/design/frontend/Acme/default/web/tailwind ci --ignore-scripts
npm --prefix path/to/project/app/design/frontend/Acme/default/web/tailwind run build

```

--------------------------------

### Install Stripe integration

Source: https://docs.hyva.io/hyva-checkout/integrations/available-payment-methods.html

Install the Stripe integration module for Hyvä Checkout. Run the composer require command followed by bin/magento setup:upgrade to complete the installation.

```bash
composer require hyva-themes/magento2-hyva-checkout-stripe
bin/magento setup:upgrade

```

--------------------------------

### Deploy Koti Sample Data

Source: https://docs.hyva.io/hyva-themes/faqs/sample-data.html

Deploy the Koti sample data using Magento's CLI, then run a setup upgrade. This is required after deploying the sample data.

```bash
bin/magento hyva:sampledata:deploy
bin/magento setup:upgrade

```

--------------------------------

### Install ScalaPay integration

Source: https://docs.hyva.io/hyva-checkout/integrations/available-payment-methods.html

Install the ScalaPay integration adapter for Hyvä Checkout. Run the composer require command followed by bin/magento setup:upgrade to complete the installation.

```bash
composer require scalapay/scalapay-magento-2-hyva-adapter
bin/magento setup:upgrade

```

--------------------------------

### Install SatisPay integration

Source: https://docs.hyva.io/hyva-checkout/integrations/available-payment-methods.html

Install the SatisPay integration module for Hyvä Checkout. Run the composer require command followed by bin/magento setup:upgrade to complete the installation.

```bash
composer require hyva-themes/magento2-hyva-checkout-satispay
bin/magento setup:upgrade

```

--------------------------------

### Install PensoPay integration

Source: https://docs.hyva.io/hyva-checkout/integrations/available-payment-methods.html

Install the PensoPay integration module for Hyvä Checkout. Run the composer require command followed by bin/magento setup:upgrade to complete the installation.

```bash
composer require hyva-themes/magento2-hyva-checkout-pensopay-payment
bin/magento setup:upgrade

```
Tokens:
Raw