Shared Types Module For VirtoCommerce Frontend

This module aims to share types from the main frontend app among frontend modules. It provides a centralized location for type definitions that can be used across various modules to ensure consistency and reduce duplication.

Installation

Install the latest version of the shared types module:

yarn add @virto-commerce/front-modules-shared-types

or install a specific version:

yarn add @virto-commerce/[email protected]

Usage

Export Shared Types

The main file for the shared types module is located in shared-types/index.ts.

Example shared-types/index.ts

export type { Breadcrumb, CartType, CustomerOrderType } from "../client-app/core/api/graphql/types.js";
export type { LoggerType } from "../client-app/core/utilities/logger/logger.type.js";
export type { ICurrency } from "../client-app/core/types/currency.js";

Publishing the Package

To publish the package, push a commit where:

1. shared-types/index.ts is changed
2. The commit message contains publish-shared-types

The types declaration file will be built and published automatically. The patch version of the package will be increased automatically - ensure that you pull changes (shared-types/package.json) after CI jobs are done.

Example of Using in Other Modules

1. Install the shared types module:

yarn add @virto-commerce/front-modules-shared-types

2. Import the shared types into your module:

import type { Breadcrumb, CartType } from "@virto-commerce/front-modules-shared-types";

Links

• Npm module

License

Copyright (c) Virto Solutions LTD. All rights reserved.

This software is licensed under the Virto Commerce Open Software License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://virtocommerce.com/opensourcelicense.