Services Exports Bundle

Table of Contents

Export Package Name: services
- Export Sub-Package Name: ConditionalHelper
- Export Sub-Package Name: TenantService

Export Package Name: `services`

How to pull in the module and its components

import { services } from '@broadleaf/admin-components';

const { ActionRegistrar } = services;

Component Name Description

Component Name	Description
`ActionRegistrar`	A service used for registering and accessing custom Action components for various metadata-driven components.
`AuthService`	A service used for various authentication functions, such as checking tokens, getting authenticated user information, logging in and out, among others.
`ClientDiscoveryService`	A service that retrieves the client information for the provided tenant, application, and type.
`ComponentRegistrar`	A service that manages components for the metadata-driven rendering of the application.
`DefaultValueService`	A service that manages and returns default values for fields across the application.
`SchemaService`	A service that manages and handles Yup Validation schema operations, providers, and constants.
`TranslateModeService`	A service that manages and gets the translations for the given metadata and form values.
`UserAccessService`	A service that checks for the user’s access authorization by checking the operation against their accessible scopes.

ActionRegistrar

A service used for registering and accessing custom Action components for various metadata-driven components.

AuthService

A service used for various authentication functions, such as checking tokens, getting authenticated user information, logging in and out, among others.

ClientDiscoveryService

A service that retrieves the client information for the provided tenant, application, and type.

ComponentRegistrar

A service that manages components for the metadata-driven rendering of the application.

DefaultValueService

A service that manages and returns default values for fields across the application.

SchemaService

A service that manages and handles Yup Validation schema operations, providers, and constants.

TranslateModeService

A service that manages and gets the translations for the given metadata and form values.

UserAccessService

A service that checks for the user’s access authorization by checking the operation against their accessible scopes.

Export Sub-Package Name: `ConditionalHelper`

How to pull in the module and its components

import { services } from '@broadleaf/admin-components';

const { BooleanConditionalProvider } = services.ConditionalHelper;

Component Name Description

Component Name	Description
`BooleanConditionalProvider`	A provider that provides functions to evaluate logical conditionals.
`CollectionConditionalProvider`	A provider that provides functions to evaluate collection-type conditionals against the provided set of values.
`evaluateConditionals`	A function that evaluates the passed conditionals in order against the passed set of values. If a conditional is not met, the method short-circuits with the failure.
`PropertyConditionalProvider`	A provider that provides functions to evaluate property-based conditionals.
`registerConditionalProvider`	Registers a new conditional provider for the application. A provider is expected to have three properties: `evaluate`, `canHandle`, and `order`.
`registeredConditionalProviders`	The list of registered conditional providers for the application. Starts with the default OOB conditional providers in the application.
`resetConditionalProviders`	Resets the list of registered conditional providers to the defaults.

BooleanConditionalProvider

A provider that provides functions to evaluate logical conditionals.

CollectionConditionalProvider

A provider that provides functions to evaluate collection-type conditionals against the provided set of values.

evaluateConditionals

A function that evaluates the passed conditionals in order against the passed set of values. If a conditional is not met, the method short-circuits with the failure.

PropertyConditionalProvider

A provider that provides functions to evaluate property-based conditionals.

registerConditionalProvider

Registers a new conditional provider for the application. A provider is expected to have three properties: evaluate, canHandle, and order.

registeredConditionalProviders

The list of registered conditional providers for the application. Starts with the default OOB conditional providers in the application.

resetConditionalProviders

Resets the list of registered conditional providers to the defaults.

Export Sub-Package Name: `TenantService`

How to pull in the module and its components

import { services } from '@broadleaf/admin-components';

const { getApplications } = services.TenantService;

Component Name Description

Component Name	Description
`getApplications`	An asynchronous function that retrieves the set of applications for the given tenant.
`getResolvedApplicationUrl`	An asynchronous function that resolves the URL of the application with the provided ID.
`resolveAdminTenant`	An asynchronous function that retrieves the tenant response details for the current browser location.

getApplications

An asynchronous function that retrieves the set of applications for the given tenant.

getResolvedApplicationUrl

An asynchronous function that resolves the URL of the application with the provided ID.

resolveAdminTenant

An asynchronous function that retrieves the tenant response details for the current browser location.

Services Exports Bundle

Export Package Name: services

Export Sub-Package Name: ConditionalHelper

Export Sub-Package Name: TenantService

Export Package Name: `services`

Export Sub-Package Name: `ConditionalHelper`

Export Sub-Package Name: `TenantService`