User Auth initialization

The User Auth initializer configures authentication and authorization features including login, registration, password management, and session handling. Use initialization to customize authentication flows and user data models.

Version: 2.1.5

Configuration options

The following table describes the configuration options available for the User Auth initializer:

Parameter	Type	Req?	Description
langDefinitions	LangDefinitions	No	Language definitions for internationalization (i18n). Override dictionary keys for localization or branding.
models	Record<string, any>	No	Custom data models for type transformations. Extend or modify default models with custom fields and transformers.
authHeaderConfig	authHeaderConfig	Yes	Configures authentication header format for API requests including custom header names and token prefix format (e.g., ‘Bearer’, ‘Token’).

Basic initialization

Initialize the drop-in with default settings:

import { initializers } from '@dropins/tools/initializer.js';
import { initialize } from '@dropins/storefront-auth';

await initializers.mountImmediately(initialize, {});

Language definitions

Override dictionary keys for localization or branding. The langDefinitions object maps locale keys to custom strings that override the drop-in’s default text.

import { initializers } from '@dropins/tools/initializer.js';
import { initialize } from '@dropins/storefront-auth';

const customStrings = {
  'AddToCart': 'Add to Bag',
  'Checkout': 'Complete Purchase',
  'Price': 'Cost',
};

const langDefinitions = {
  default: customStrings,
};

await initializers.mountImmediately(initialize, { langDefinitions });

Tip

For complete dictionary customization including all available keys and multi-language support, see the User Auth Dictionary page.

Customizing data models

Extend or transform data models by providing custom transformer functions. Use the models option to add custom fields or modify existing data structures returned from the backend.

Available models

The following models can be customized through the models configuration option:

Model	Description
CustomerModel	Transforms customer authentication data including profile information, addresses, and account settings. Use this to add custom fields or modify user data structures.

The following example shows how to customize the CustomerModel model for the User Auth drop-in:

import { initializers } from '@dropins/tools/initializer.js';
import { initialize } from '@dropins/storefront-auth';

const models = {
  CustomerModel: {
    transformer: (data) => ({
      // Add custom fields from backend data
      customField: data?.custom_field,
      promotionBadge: data?.promotion?.label,
      // Transform existing fields
      displayPrice: data?.price?.value ? `$${data.price.value}` : 'N/A',
    }),
  },
};

await initializers.mountImmediately(initialize, { models });

Drop-in-specific configuration

The User Auth drop-in provides additional configuration options beyond the standard langDefinitions and models. These options customize drop-in-specific behaviors and features.

import { initializers } from '@dropins/tools/initializer.js';
import { initialize } from '@dropins/storefront-auth';

await initializers.mountImmediately(initialize, {
  // Drop-in-specific configuration
  authHeaderConfig: {},
});

Note

Refer to the Configuration options table for descriptions of each option.

Configuration types

The following TypeScript definitions show the structure of each configuration object:

authHeaderConfig

Configures authentication header format for API requests including custom header names and token prefix format (e.g., ‘Bearer’, ‘Token’).

authHeaderConfig: {
    header: string;
    tokenPrefix: string;
  }

langDefinitions

Maps locale identifiers to dictionaries of key-value pairs. The default locale is used as the fallback when no specific locale matches. Each dictionary key corresponds to a text string used in the drop-in UI.

langDefinitions?: {
  [locale: string]: {
    [key: string]: string;
  };
};

models

Maps model names to transformer functions. Each transformer receives data from GraphQL and returns a modified or extended version. Use the Model<T> type from @dropins/tools to create type-safe transformers.

models?: {
  [modelName: string]: Model<any>;
};

Model definitions

The following TypeScript definitions show the structure of each customizable model:

CustomerModel

export interface CustomerModel {
  firstName: string;
  lastName: string;
  email: string;
  groupUid: string;
  customAttributes?: Record<string, string>[];
  errors?: { message: string }[];
}