@lipagas/storefront-engine/addon/controllers/base-controller.js

Headless Commerce & Marketplace Extension for Fleetbase

import Controller from '@ember/controller';
import { inject as service } from '@ember/service';
import { action } from '@ember/object';

export default class BaseController extends Controller {
    /**
     * Inject the `universe` service
     *
     * @var {Service}
     */
    @service universe;

    /**
     * Transitions to a specified route within the '@lipagas/orefront-engine' engine.
     *
     * This action is a wrapper around the `transitionToEngineRoute` method of the `universe` service (or object),
     * specifically targeting the '@lipagas/storefront-engine'. It allows for easy transitioning to routes
     * within this engine, abstracting away the need to repeatedly specify the engine name.
     *
     * @param {string} route - The route within the '@lipagas/storefront-engine' to transition to.
     * @param {...any} args - Additional arguments to pass to the transitionToEngineRoute method.
     * @returns {Promise} A Promise that resolves with the result of the transitionToEngineRoute method.
     *
     * @example
     * // To transition to the 'management.fleets.index.new' route within the '@lipagas/storefront-engine'
     * this.transitionToRoute('management.fleets.index.new');
     */
    @action transitionToRoute(route, ...args) {
        return this.universe.transitionToEngineRoute('@lipagas/storefront-engine', route, ...args);
    }
}