configsSubstore

Manages the lifecycle of user configurations in the current session. A configuration (TConfig) pairs a form with a name, a quantity, and a derived completion status. All form state and selected values are stored separately (in formSubstore and valuesSubstore) and automatically kept in sync when a config is added, removed, or copied.

Table of contents

Properties

• currentConfigId
• configsCounter
• configs

Methods

• setCurrentConfigId
• addConfig
• removeConfig
• updateConfig
• updateConfigPosition
• copyConfig
• setupFromPreConfig

---

Properties

currentConfigId

currentConfigId: number | undefined

ID of the currently active configuration, or undefined when none is selected.

Use this to scope reads from formSubstore.fromConfigs and valuesSubstore.valuesConfigs to the active config.

Related

• configs — the full list; currentConfigId is always one of its id values
• setCurrentConfigId — setter
• formSubstore.fromConfigs — keyed by currentConfigId
• valuesSubstore.valuesConfigs — keyed by currentConfigId

---

configsCounter

configsCounter: number

Auto-incrementing counter used to assign unique IDs to new configurations.

Each call to addConfig increments this counter and uses the resulting value as the new config’s id. You do not need to manage this directly.

Related

• addConfig — consumes and increments this counter

---

configs

configs: TConfig[]

Ordered list of all configurations in the current session.

type TConfig = {
  id: number;
  name: string;
  formId: number;
  formName: string;
  status: "in-progress" | "completed" | "incomplete";
  configQuantity: number;
  missingRequiredElements: TMissingRequiredElement[];
};

type TMissingRequiredElement = {
  id: number;
  groupId: number | undefined;
  label: string;
};

status is derived automatically from the values in valuesSubstore:

• "completed" — all required elements have a selection
• "incomplete" — at least one required element is missing a selection
• "in-progress" — the config has not been interacted with yet

Related

• currentConfigId — points at one entry in this list
• addConfig / removeConfig / copyConfig — mutate this list
• finishedConfigsSubstore.getFinishedConfigs — filters this list to completed configs
• submitSubstore.submit — iterates over this list to build the submission payload
• numberFormatterSubstore.calculateConfigPrice — uses configQuantity from each entry

---

Methods

setCurrentConfigId

setCurrentConfigId: (configId: number) => void

Sets the currently active configuration by ID.

Parameters

Name	Type	Description
configId	number	ID of an existing config in configs

Related

• currentConfigId — the value this method writes

---

addConfig

addConfig: (
  config: Omit<TConfig, "id" | "status" | "missingRequiredElements">,
  preConfig?: TPreConfigConfig,
) => number

Adds a new configuration entry and returns its generated ID.

Internally the SDK:

1. Increments configsCounter to produce the new id
2. Initialises a FormStoreItem in formSubstore.fromConfigs for this config
3. Initialises a ValuesStoreItem in valuesSubstore.valuesConfigs for this config
4. If preConfig is provided, pre-fills values and quantities accordingly

Parameters

Name	Type	Description
config	Omit<TConfig, "id" | "status" | "missingRequiredElements">	Config metadata (name, formId, formName, configQuantity)
preConfig	TPreConfigConfig (optional)	Pre-filled values/quantities to apply on creation

Returns number — the newly assigned config ID.

Related

• configsCounter — incremented on each call
• formSubstore.fromConfigs — a new entry is created here
• valuesSubstore.valuesConfigs — a new entry is created here
• removeConfig — inverse operation

---

removeConfig

removeConfig: (configId: number) => void

Removes a configuration and all associated form and value data.

The SDK also removes the corresponding entries from formSubstore.fromConfigs and valuesSubstore.valuesConfigs. If the removed config was the active one, currentConfigId is cleared.

Parameters

Name	Type	Description
configId	number	ID of the config to remove

Related

• formSubstore.fromConfigs — entry is deleted
• valuesSubstore.valuesConfigs — entry is deleted
• addConfig — inverse operation

---

updateConfig

updateConfig: (
  configId: number,
  config: Partial<Omit<TConfig, "id" | "formName" | "status">>,
) => void

Partially updates a configuration’s metadata fields.

Only name, formId, and configQuantity can be changed. id, formName, and status are immutable through this method.

Parameters

Name	Type	Description
configId	number	ID of the config to update
config	Partial<Omit<TConfig, "id" | "formName" | "status">>	Fields to update

Related

• configs — the list is updated in place

---

updateConfigPosition

updateConfigPosition: (configId: number, newPosition: number) => void

Reorders a configuration to a new index in the list.

newPosition is zero-based. The config is removed from its current position and inserted at newPosition.

Parameters

Name	Type	Description
configId	number	ID of the config to move
newPosition	number	Target zero-based index

Related

• configs — the ordering of this array is changed

---

copyConfig

copyConfig: (configId: number) => void

Duplicates an existing configuration, including its form and value data.

The SDK:

1. Creates a new config entry with incremented ID (via addConfig internally)
2. Deep-copies the form state from formSubstore.fromConfigs[configId]
3. Deep-copies values and quantities from valuesSubstore.valuesConfigs[configId]

Parameters

Name	Type	Description
configId	number	ID of the config to duplicate

Related

• formSubstore.fromConfigs — source and destination of the copy
• valuesSubstore.valuesConfigs — source and destination of the copy

---

setupFromPreConfig

setupFromPreConfig: (
  preConfig: TPreConfig,
  args: {
    defaultConfigName: string;
    skipCleanConfigs?: boolean;
  },
) => void

Initialises the store from a pre-configuration object, replacing existing configs.

A TPreConfig encodes one or more configurations with their pre-filled values, quantities, and optional contact-field overrides. After this call the store’s configs list is replaced with the configs described in preConfig.

Set skipCleanConfigs: true to append to the existing list instead of replacing it.

Parameters

Name	Type	Description
preConfig	TPreConfig	Pre-configuration payload
args.defaultConfigName	string	Fallback name for configs that don’t specify one
args.skipCleanConfigs	boolean (optional)	When true, existing configs are kept and new ones are appended

Related

• contactDetailsSubstore.tempPreConfigRequestFields — request-field overrides from preConfig are written here
• submitSubstore.openFromDraft — uses this method internally to restore state from a draft