@kosdev-code/kos-dispense-sdk 3.0.26 → 3.0.27

package/{extension-utils-CwctwFhK.cjs → extension-utils-Cfhe358W.cjs}

@@ -80,55 +80,18 @@ const getFuelGaugeValue = (holder) => {
 class DispenseExtensionManager {
   core = new kosUiSdk.CoreExtensionManager();
   /**
-   * Maps data into the {@link IngredientModel}
+   * Registers a data mapper for the {@link IngredientModel}.
    *
-   * It is common for the ingredient data provided by the ingredient service to be augmented with additional properties that are
-   * not provided by the base KOS Ingredient model. The {@link IngredientMapper} extension point allows for the data to be mapped
-   * into the {@link IngredientModel} and the {@link IngredientModel.data} property to be augmented with additional properties.
+   * Ingredient service data often needs properties the base model does not carry. The mapper receives each
+   * {@link IngredientResponse} and the data returned by the ingredient loader as context, and its result
+   * becomes the model's `data` property.
    *
    * @param ingredientDataMapper - Mapping function that maps an {@link IngredientResponse} into additional model data
    * @param options - Optional {@link ExtensionOptions} to control failure behavior.
    *   Defaults to `failurePolicy: "throw"`, which throws an {@link ExtensionException} on mapper failure.
    *   Set to `"continue"` to log the error and continue processing remaining mappers.
    * @returns this instance for chaining
-   *
-   * @example
-   * The following example shows how to map the data from the service response into the {@link IngredientModel}.
-   * The context is provided by the {@link IngredientLoader} extension point with its data being used to optionally augment the
-   * ingredient data.
-   *
-   * The result of the mapping will be available in the `data` property of the {@link IngredientModel}.
-   *
-   * In this case the `IngedientReponseData` interface represents the data being returned by the ingredient service and the
-   * `IngredientData` interface represents the data that will be available in the {@link IngredientModel.data} property.  The `ingredientDataMapper`
-   * is responsible for mapping from one format to the other.
-   *
-   * ```typescript
-   *
-   * interface IngredientResponseData extends NozzleServices.IngredientResponse {
-   *   chilled: boolean;
-   *   carbonated: boolean;
-   *   highYield: boolean;
-   * }
-   *
-   * interface IngredientData {
-   *   chilled: boolean;
-   *   carbonated: boolean;
-   *   highYield: boolean;
-   * }
-   *
-   * export const ingredientDataMapper = async (
-   * data: IngredientResponseData,
-   * context: IngredientContext
-   * ): Promise<IngredientData> => {
-   *  return {
-   *    chilled: data.chilled,
-   *    carbonated: data.carbonated,
-   *    highYield: data.highYield,
-   *  }
-   * }
-   * ```
-   * */
+   */
   registerIngredientDataMapper(ingredientDataMapper, options) {
     kosUiSdk.ExtensionManager.dataMapper.registerDataMapper(
       dispenseRegistrationManager.ExtensionType.IngredientMapper,
@@ -138,34 +101,14 @@ class DispenseExtensionManager {
     return this;
   }
   /**
-   * Loads data that will be provided as context into the {@link IngredientMapper}.
+   * Registers a loader whose result is passed as context to the ingredient data and type mappers.
    *
    * @param ingredientLoader - Async function that loads and returns ingredient context data
    * @param options - Optional {@link ExtensionOptions} to control failure behavior.
    *   Defaults to `failurePolicy: "throw"`, which throws an {@link ExtensionException} on loader failure.
    *   Set to `"continue"` to log the error and return `undefined` instead.
    * @returns this instance for chaining
-   *
-   * @example
-   * The following example shows how to load the brandset data, normalize it into a map and then provide it back to the framework
-   * where it can be used by the other extension points.
-   *
-   * In the ingredient container model, the data is provided to the {@link IngredientMapper} extension point in order to augment ingredient data
-   * and also loaded into the ingredient container model context in order to make the data available throughout the code.
-   *
-   * ```typescript
-   *  export const ingredientContextLoader = async (): Promise<BeverageContext> => {
-   *  const response = await kosFetch('kos:/system/some/ingredient/endpoint.json');
-   *
-   *   if (response.status !== 200) {
-   *     KosLog.error('Failed to load ingredient data');
-   *       return {};
-   *   }
-   *  const json = await response.json();
-   *  return json;
-   *  };
-   * ```
-   * */
+   */
   registerIngredientLoader(ingredientLoader, options) {
     kosUiSdk.ExtensionManager.loader.registerLoader(
       dispenseRegistrationManager.ExtensionType.IngredientLoader,
@@ -261,7 +204,10 @@ class DispenseExtensionManager {
     return this;
   }
   /**
-   * Maps data into the {@link AvailabilityModel}.
+   * Registers a data mapper for the {@link AvailabilityModel}.
+   *
+   * The mapper receives each availability node, with its `groupId`, and the data returned by the
+   * availability loader as context. Its result becomes the model's `data` property.
    *
    * @param availabilityMapper - Mapping function that maps a {@link GroupBeverageResponse} into additional availability data
    * @param options - Optional {@link ExtensionOptions} to control failure behavior.
@@ -270,28 +216,15 @@ class DispenseExtensionManager {
    * @returns this instance for chaining
    *
    * @example
-   * The following example shows how to map the data from the service response into the {@link AvailabilityModel}.
-   * The context is provided by the {@link AvailabilityLoader} extension point with its data being used to augment the
-   * availability data.
-   *
-   * The result of the mapping will be available in the `data` property of the {@link AvailabilityModel}.
-   *
    * ```typescript
-   * export const beverageDataMapper = async (
-   * data: NozzleServices.BeverageResponse,
-   * context: BeverageContext
-   * ): Promise<BeverageData> => {
-   *  const id = data.altId;
-   *  const iconUrl = encodeURI(
-   *    `http://localhost:8081/system/brandset/${context?.[id]?.icon}`
-   *  );
-   *  const cuiColorCode = context?.[id]?.cuiColorCode
-   *    ? context?.[id]?.cuiColorCode
-   *    : '';
-   *  return { iconUrl, cuiColorCode };
-   * };
+   * const beverageDataMapper: AvailabilityDataMapper<BeverageData> = async (
+   *   data,
+   *   context?: Record<string, BrandsetIngredient>
+   * ) => ({
+   *   iconUrl: context?.[data.altId]?.icon ?? "",
+   * });
    * ```
-   * */
+   */
   registerAvailabilityDataMapper(availabilityMapper, options) {
     kosUiSdk.ExtensionManager.dataMapper.registerDataMapper(
       dispenseRegistrationManager.ExtensionType.AvailabilityMapper,
@@ -301,7 +234,8 @@ class DispenseExtensionManager {
     return this;
   }
   /**
-   * Loads data that will be provided as context into the {@link AvailabilityMapper}.
+   * Registers a loader whose result is passed as context to the availability data mapper. A common use is
+   * loading UI-specific brandset data that the backend service does not provide.
    *
    * @param availabilityLoader - Async function that loads and returns availability context data
    * @param options - Optional {@link ExtensionOptions} to control failure behavior.
@@ -310,32 +244,14 @@ class DispenseExtensionManager {
    * @returns this instance for chaining
    *
    * @example
-   * A common use case is to load brandset data that is UI specific and not provided directly by the Java service.
-   *
-   * The following example shows how to load the brandset data, normalize it into a map and then provide it back to the framework
-   * where it can be used by the other extension points.
-   *
-   * In the nozzle model, the data is provided to the {@link AvailabilityMapper} extension point in order to augment availability data
-   * and also loaded into the nozzle model context in order to make the data available throughout the code.
-   *
    * ```typescript
-   *  export const beverageContextLoader = async (): Promise<BeverageContext> => {
-   *  const response = await kosFetch('kos:/system/brandset/brandset.json');
-   *
-   *   if (response.status !== 200) {
-   *     KosLog.error('Failed to load beverage data');
-   *       return {};
-   *   }
-   *   const json: BrandsetResponse | null = await response.json();
-   *   const initialBeverages: Record<string, BrandsetIngredient> = {};
-   *   const beverages = json?.ingredients?.reduce((acc, beverage) => {
-   *     acc[beverage.ingredientId] = beverage;
-   *     return acc;
-   *   }, initialBeverages);
-   *  return beverages;
-   *  };
+   * const beverageContextLoader = async () => {
+   *   const response = await kosFetch("kos:/system/brandset/brandset.json");
+   *   const json: BrandsetResponse = await response.json();
+   *   return Object.fromEntries(json.ingredients.map((i) => [i.ingredientId, i]));
+   * };
    * ```
-   * */
+   */
   registerAvailabilityLoader(availabilityLoader, options) {
     kosUiSdk.ExtensionManager.loader.registerLoader(
       dispenseRegistrationManager.ExtensionType.AvailabilityLoader,
@@ -362,9 +278,8 @@ class DispenseExtensionManager {
     return this;
   }
   /**
-   * Maps data into the {@link AssemblyModel} data.
-   * Used in cases where the base assembly has been extended with additional properties in the backend.  This extension
-   * point allows for the data to be mapped into the {@link AssemblyModel} and augmented with additional properties.
+   * Registers a data mapper for the {@link AssemblyModel}, for backends that extend the assembly response
+   * with additional properties. The mapper's result is merged into the assembly model.
    *
    * @param assemblyDataMapper - Mapping function that maps an {@link AssemblyTypes.AssemblyResponse} into additional assembly data
    * @param options - Optional {@link ExtensionOptions} to control failure behavior.
@@ -373,60 +288,18 @@ class DispenseExtensionManager {
    * @returns this instance for chaining
    *
    * @example
-   *
-   * In this example of an implementation of a {@link AssemblyMapper}, the {@link AssemblyResponse} data is mapped into
-   * a {@link FreestyleAssembly} object.
-   *
-   * The {@link FreestyleAssemblyResponse} interface represents the additional data being returned by the assembly service and is
-   * merged into the {@link AssemblyResponse} interface.
-   *
-   * The {@link FreestyleAssembly} interface represents the additional data, beyond the base data set, that will be merged into the {@link AssemblyModel}.
-   *
-   * The mapper is responsible for mapping from the {@link FreestyleAssemblyResponse} format to the {@link FreestyleAssembly} format.
    * ```typescript
-   *  import { AssemblyTypes } from "@kosdev-code/kos-dispense-sdk";
-   *  import { DataMapper } from "@kosdev-code/kos-ui-sdk";
-   *
-   *  // define the additional data being returned by the assembly service
-   *  export interface FreestyleAssemblyResponse {
-   *    iceAgitator?: {
-   *      name: "iceAgitator";
-   *      path: string;
-   *    };
-   *  }
-   *
-   *  // define the additional data structure that will be merged into the assembly model
-   *  export interface FreestyleAssembly {
-   *    iceAgitator: {
-   *      path: string;
-   *    };
-   *    carbAgitator: {
-   *      path: string;
-   *    };
-   *  }
-   *
-   *
-   *  // define the mapper that will map the data from the service response into the additional data structure
-   *  // that will be merged into the assembly model.
-   *  // In this case the mapper is responsible for mapping from the {@link FreestyleAssemblyResponse} format to the {@link FreestyleAssembly} format.
-   *  export const assemblyDataMapper: DataMapper<
-   *    AssemblyTypes.AssemblyResponse<FreestyleAssemblyResponse>,
-   *    FreestyleAssembly
-   *    > = async (data) => {
-   *    const response = data.assemblies.reduce((acc, assembly) => {
-   *      const agitatorKeys = ["iceAgitator", "carbAgitator"];
-   *      agitatorKeys.forEach((key) => {
-   *        const agitator = assembly[key];
-   *        if (agitator) {
-   *          acc[key] = agitator;
-   *        }
-   *      });
+   * interface IceAgitatorExt {
+   *   iceAgitator?: { name: string; path: string };
+   * }
    *
-   *      return acc;
-   *    }, {} as FreestyleAssembly);
-   *    return response;
-   *  };
-   *```
+   * const assemblyDataMapper: AssemblyMapper<
+   *   { iceAgitatorPath?: string },
+   *   AssemblyTypes.AssemblyResponse<{ AssemblyExt: IceAgitatorExt }>
+   * > = async (data) => ({
+   *   iceAgitatorPath: data.assemblies.find((a) => a.iceAgitator)?.iceAgitator?.path,
+   * });
+   * ```
    */
   registerAssemblyDataMapper(assemblyDataMapper, options) {
     kosUiSdk.ExtensionManager.dataMapper.registerDataMapper(
@@ -486,4 +359,4 @@ exports.index$2 = index$4;
 exports.index$3 = index$5;
 exports.index$4 = index$1;
 exports.index$5 = index$2;
-//# sourceMappingURL=extension-utils-CwctwFhK.cjs.map
+//# sourceMappingURL=extension-utils-Cfhe358W.cjs.map

package/extension-utils-Cfhe358W.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension-utils-Cfhe358W.cjs","sources":["../../../packages/kos-dispense-sdk/src/models/models/holder/utils/holder-utils.ts","../../../packages/kos-dispense-sdk/src/models/utils/extension-utils.ts"],"sourcesContent":["import { kosAutoEffect } from \"@kosdev-code/kos-ui-sdk\";\nimport { useEffect, useState } from \"react\";\nimport type { HolderModel } from \"../types\";\n\nexport const getFuelGaugeValue = (holder: HolderModel) => {\n  const [maxVolume, setMaxVolume] = useState<number>(\n    holder?.slice?.maxVolMl ?? 0\n  );\n  const [remainingVolume, setRemainingVolume] = useState<number>(\n    holder?.slice?.currentVolMl ?? 0\n  );\n\n  const [hasMaxVolume, setHasMaxVolume] = useState<boolean>(\n    holder?.slice?.maxVolMl !== undefined\n  );\n\n  const [hasRemainingVolume, setHasRemainingVolume] = useState<boolean>(\n    holder?.slice?.currentVolMl !== undefined\n  );\n\n  const [fillPercent, setFillPercent] = useState<number>(\n    remainingVolume <= 0\n      ? 0\n      : Math.floor(((remainingVolume || 1) / (maxVolume || 1)) * 100)\n  );\n\n  const [hasFuelGuage, setHasFuelGuage] = useState<boolean>(\n    hasMaxVolume && hasRemainingVolume\n  );\n\n  useEffect(() => {\n    const disposer = kosAutoEffect(() => {\n      setMaxVolume(holder?.slice?.maxVolMl ?? 0);\n      setRemainingVolume(holder?.slice?.currentVolMl ?? 0);\n      setHasMaxVolume(holder?.slice?.maxVolMl !== undefined);\n      setHasRemainingVolume(holder?.slice?.currentVolMl !== undefined);\n      setFillPercent(\n        remainingVolume <= 0\n          ? 0\n          : Math.floor(((remainingVolume || 1) / (maxVolume || 1)) * 100)\n      );\n      setHasFuelGuage(hasMaxVolume && hasRemainingVolume);\n    });\n\n    return () => {\n      disposer();\n    };\n  }, [holder]);\n\n  return { maxVolume, remainingVolume, fillPercent, hasFuelGuage };\n};\n","/* eslint-disable @typescript-eslint/no-explicit-any */\nimport {\n  CoreExtensionManager,\n  DataLoader,\n  DataMapper,\n  EXTENSION_FEATURE_FLAG_RESOLVER,\n  ExtensionManager,\n  ExtensionOptions,\n  IndexExtension,\n  PropertyMapper,\n  type FlagResolver,\n} from \"@kosdev-code/kos-ui-sdk\";\nimport { ExtensionType } from \"../constants\";\nimport { AssemblyTypes, type AssemblyModel } from \"../models\";\nimport type { HolderResponse } from \"../models/holder/services\";\nimport type { HolderModel } from \"../models/holder/types\";\nimport type { IngredientResponse } from \"../models/ingredient/services\";\nimport type { BeverageResponse } from \"../models/nozzle/services\";\nimport type { SelectedPourable } from \"../models/nozzle/types\";\n\nexport type IngredientDataMapper<\n  AdditionalData extends object = Record<string, any>\n> = DataMapper<IngredientResponse, AdditionalData, any>;\n\n/**\n * Mapping function that maps an ingredient response into the type property of\n * the {@link IngredientModel}.\n */\nexport type IngredientTypeMapper<\n  T extends IngredientResponse = IngredientResponse\n> = PropertyMapper<T, string>;\n\n/**\n * Mapping function that maps additional data from holder service response\n * into the {@link HolderModel} data.\n */\nexport type HolderTypeMapper<T extends HolderResponse = HolderResponse> =\n  PropertyMapper<T, string>;\n\n/**\n * Mapping function that maps additional data from holder service response\n * into the {@link HolderModel} data.\n */\nexport type HolderDataMapper<\n  AdditionalData extends object = Record<string, any>,\n  HolderData extends HolderResponse = HolderResponse\n> = DataMapper<HolderData, AdditionalData, any>;\n\nexport type GroupBeverageResponse = BeverageResponse & { groupId: string };\nexport type AvailabilityDataMapper<\n  AdditionalData extends object = Record<string, any>,\n  AvailabilityData extends GroupBeverageResponse = GroupBeverageResponse\n> = DataMapper<AvailabilityData, AdditionalData, any>;\n\nexport type SelectedPourableMapper = DataMapper<SelectedPourable, any>;\n\nexport type BoardDataMapper<\n  AdditionalData extends object = Record<string, any>,\n  BoardData extends AssemblyTypes.AssemblyBoard<any> = AssemblyTypes.AssemblyBoard<any>\n> = DataMapper<BoardData, AdditionalData, any>;\n\nexport type AssemblyMapper<\n  AdditionalData extends object = Record<string, any>,\n  AssemblyResponseData extends AssemblyTypes.AssemblyResponse<any> = AssemblyTypes.AssemblyResponse<any>\n> = DataMapper<AssemblyResponseData, AdditionalData, any>;\n/**\n * The DispenseExtensionManager is responsible for managing the extension points that are specific to the Dispense application.\n */\nexport class DispenseExtensionManager {\n  core: CoreExtensionManager = new CoreExtensionManager();\n  /**\n   * Registers a data mapper for the {@link IngredientModel}.\n   *\n   * Ingredient service data often needs properties the base model does not carry. The mapper receives each\n   * {@link IngredientResponse} and the data returned by the ingredient loader as context, and its result\n   * becomes the model's `data` property.\n   *\n   * @param ingredientDataMapper - Mapping function that maps an {@link IngredientResponse} into additional model data\n   * @param options - Optional {@link ExtensionOptions} to control failure behavior.\n   *   Defaults to `failurePolicy: \"throw\"`, which throws an {@link ExtensionException} on mapper failure.\n   *   Set to `\"continue\"` to log the error and continue processing remaining mappers.\n   * @returns this instance for chaining\n   */\n  registerIngredientDataMapper(\n    ingredientDataMapper: IngredientDataMapper,\n    options?: ExtensionOptions\n  ) {\n    ExtensionManager.dataMapper.registerDataMapper(\n      ExtensionType.IngredientMapper,\n      ingredientDataMapper,\n      options\n    );\n\n    return this;\n  }\n\n  /**\n   * Registers a loader whose result is passed as context to the ingredient data and type mappers.\n   *\n   * @param ingredientLoader - Async function that loads and returns ingredient context data\n   * @param options - Optional {@link ExtensionOptions} to control failure behavior.\n   *   Defaults to `failurePolicy: \"throw\"`, which throws an {@link ExtensionException} on loader failure.\n   *   Set to `\"continue\"` to log the error and return `undefined` instead.\n   * @returns this instance for chaining\n   */\n  registerIngredientLoader(\n    ingredientLoader: DataLoader,\n    options?: ExtensionOptions\n  ) {\n    ExtensionManager.loader.registerLoader(\n      ExtensionType.IngredientLoader,\n      ingredientLoader,\n      options\n    );\n    return this;\n  }\n\n  registerIngredientIndex(ingredientIndex: IndexExtension) {\n    ExtensionManager.indexExtension.registerIndexExtension(\n      ExtensionType.IngredientIndex,\n      ingredientIndex\n    );\n    return this;\n  }\n\n  /**\n   * Registers a property mapper that derives the `type` property of the {@link IngredientModel}\n   * from an {@link IngredientResponse}.\n   *\n   * @param ingredientTypeMapper - Mapping function that extracts a type string from an {@link IngredientResponse}\n   * @param options - Optional {@link ExtensionOptions} to control failure behavior.\n   *   Defaults to `failurePolicy: \"throw\"`, which throws an {@link ExtensionException} on mapper failure.\n   *   Set to `\"continue\"` to log the error and return a fallback value instead.\n   * @returns this instance for chaining\n   * */\n  registerIngredientTypeMapper(\n    ingredientTypeMapper: IngredientTypeMapper,\n    options?: ExtensionOptions\n  ) {\n    ExtensionManager.propertyMapper.registerPropertyMapper(\n      ExtensionType.IngredientTypeMapper,\n      ingredientTypeMapper,\n      options\n    );\n    return this;\n  }\n\n  /**\n   * Registers a data mapper for the {@link HolderModel} model.\n   *\n   * @param holderDataMapper - Mapping function that maps additional data from a {@link HolderResponse}\n   * @param options - Optional {@link ExtensionOptions} to control failure behavior.\n   *   Defaults to `failurePolicy: \"throw\"`, which throws an {@link ExtensionException} on mapper failure.\n   *   Set to `\"continue\"` to log the error and continue processing remaining mappers.\n   * @returns this instance for chaining\n   */\n  registerHolderDataMapper(\n    holderDataMapper: HolderDataMapper,\n    options?: ExtensionOptions\n  ) {\n    ExtensionManager.dataMapper.registerDataMapper(\n      ExtensionType.HolderMapper,\n      holderDataMapper,\n      options\n    );\n    return this;\n  }\n\n  /**\n   * Registers a property mapper that derives the `type` property of the {@link HolderModel}\n   * from a {@link HolderResponse}.\n   *\n   * @param holderTypeMapper - Mapping function that extracts a type string from a {@link HolderResponse}\n   * @param options - Optional {@link ExtensionOptions} to control failure behavior.\n   *   Defaults to `failurePolicy: \"throw\"`, which throws an {@link ExtensionException} on mapper failure.\n   *   Set to `\"continue\"` to log the error and return a fallback value instead.\n   * @returns this instance for chaining\n   */\n  registerHolderTypeMapper(\n    holderTypeMapper: HolderTypeMapper,\n    options?: ExtensionOptions\n  ) {\n    ExtensionManager.propertyMapper.registerPropertyMapper(\n      ExtensionType.HolderTypeMapper,\n      holderTypeMapper,\n      options\n    );\n    return this;\n  }\n\n  /**\n   * Maps the ingredientId property of the holder into the {@link HolderModel}.\n   * If not provided, the ingredientId will assume that the value is mapped from the\n   * ingredientId property of the service response.\n   *\n   * @param holderTypeMapper - Mapping function that extracts the ingredientId from a {@link HolderResponse}\n   * @param options - Optional {@link ExtensionOptions} to control failure behavior.\n   *   Defaults to `failurePolicy: \"throw\"`, which throws an {@link ExtensionException} on mapper failure.\n   *   Set to `\"continue\"` to log the error and return a fallback value instead.\n   * @returns this instance for chaining\n   * */\n  registerHolderIngredientMapper(\n    holderTypeMapper: HolderTypeMapper,\n    options?: ExtensionOptions\n  ) {\n    ExtensionManager.propertyMapper.registerPropertyMapper(\n      ExtensionType.HolderTypeMapper,\n      holderTypeMapper,\n      options\n    );\n    return this;\n  }\n\n  registerHolderIndex<T extends HolderModel = HolderModel>(\n    holderIndex: IndexExtension<T>\n  ) {\n    ExtensionManager.indexExtension.registerIndexExtension(\n      ExtensionType.HolderIndex,\n      holderIndex\n    );\n    return this;\n  }\n\n  /**\n   * Registers a data mapper for the {@link AvailabilityModel}.\n   *\n   * The mapper receives each availability node, with its `groupId`, and the data returned by the\n   * availability loader as context. Its result becomes the model's `data` property.\n   *\n   * @param availabilityMapper - Mapping function that maps a {@link GroupBeverageResponse} into additional availability data\n   * @param options - Optional {@link ExtensionOptions} to control failure behavior.\n   *   Defaults to `failurePolicy: \"throw\"`, which throws an {@link ExtensionException} on mapper failure.\n   *   Set to `\"continue\"` to log the error and continue processing remaining mappers.\n   * @returns this instance for chaining\n   *\n   * @example\n   * ```typescript\n   * const beverageDataMapper: AvailabilityDataMapper<BeverageData> = async (\n   *   data,\n   *   context?: Record<string, BrandsetIngredient>\n   * ) => ({\n   *   iconUrl: context?.[data.altId]?.icon ?? \"\",\n   * });\n   * ```\n   */\n  registerAvailabilityDataMapper(\n    availabilityMapper: AvailabilityDataMapper,\n    options?: ExtensionOptions\n  ) {\n    ExtensionManager.dataMapper.registerDataMapper(\n      ExtensionType.AvailabilityMapper,\n      availabilityMapper,\n      options\n    );\n    return this;\n  }\n\n  /**\n   * Registers a loader whose result is passed as context to the availability data mapper. A common use is\n   * loading UI-specific brandset data that the backend service does not provide.\n   *\n   * @param availabilityLoader - Async function that loads and returns availability context data\n   * @param options - Optional {@link ExtensionOptions} to control failure behavior.\n   *   Defaults to `failurePolicy: \"throw\"`, which throws an {@link ExtensionException} on loader failure.\n   *   Set to `\"continue\"` to log the error and return `undefined` instead.\n   * @returns this instance for chaining\n   *\n   * @example\n   * ```typescript\n   * const beverageContextLoader = async () => {\n   *   const response = await kosFetch(\"kos:/system/brandset/brandset.json\");\n   *   const json: BrandsetResponse = await response.json();\n   *   return Object.fromEntries(json.ingredients.map((i) => [i.ingredientId, i]));\n   * };\n   * ```\n   */\n  registerAvailabilityLoader(\n    availabilityLoader: DataLoader,\n    options?: ExtensionOptions\n  ) {\n    ExtensionManager.loader.registerLoader(\n      ExtensionType.AvailabilityLoader,\n      availabilityLoader,\n      options\n    );\n    return this;\n  }\n\n  /**\n   * Maps the abstract {@link SelectedPourable} data into a format that is specific to the nozzle.\n   *\n   * @param selectedPourableMapper - Mapping function that transforms {@link SelectedPourable} data\n   * @param options - Optional {@link ExtensionOptions} to control failure behavior.\n   *   Defaults to `failurePolicy: \"throw\"`, which throws an {@link ExtensionException} on mapper failure.\n   *   Set to `\"continue\"` to log the error and continue processing remaining mappers.\n   * @returns this instance for chaining\n   * */\n  registerSelectedPourableDataMapper(\n    selectedPourableMapper: SelectedPourableMapper,\n    options?: ExtensionOptions\n  ) {\n    ExtensionManager.dataMapper.registerDataMapper(\n      ExtensionType.SelectedPourableMapper,\n      selectedPourableMapper,\n      options\n    );\n    return this;\n  }\n\n  /**\n   * Registers a data mapper for the {@link AssemblyModel}, for backends that extend the assembly response\n   * with additional properties. The mapper's result is merged into the assembly model.\n   *\n   * @param assemblyDataMapper - Mapping function that maps an {@link AssemblyTypes.AssemblyResponse} into additional assembly data\n   * @param options - Optional {@link ExtensionOptions} to control failure behavior.\n   *   Defaults to `failurePolicy: \"throw\"`, which throws an {@link ExtensionException} on mapper failure.\n   *   Set to `\"continue\"` to log the error and continue processing remaining mappers.\n   * @returns this instance for chaining\n   *\n   * @example\n   * ```typescript\n   * interface IceAgitatorExt {\n   *   iceAgitator?: { name: string; path: string };\n   * }\n   *\n   * const assemblyDataMapper: AssemblyMapper<\n   *   { iceAgitatorPath?: string },\n   *   AssemblyTypes.AssemblyResponse<{ AssemblyExt: IceAgitatorExt }>\n   * > = async (data) => ({\n   *   iceAgitatorPath: data.assemblies.find((a) => a.iceAgitator)?.iceAgitator?.path,\n   * });\n   * ```\n   */\n  registerAssemblyDataMapper(\n    assemblyDataMapper: AssemblyMapper,\n    options?: ExtensionOptions\n  ) {\n    ExtensionManager.dataMapper.registerDataMapper(\n      ExtensionType.AssemblyMapper,\n      assemblyDataMapper,\n      options\n    );\n    return this;\n  }\n\n  registerBoardIndex(boardIndex: IndexExtension) {\n    ExtensionManager.indexExtension.registerIndexExtension(\n      ExtensionType.BoardIndex,\n      boardIndex\n    );\n    return this;\n  }\n\n  /**\n   * Registers a data mapper for the board model within an assembly.\n   *\n   * @param boardDataMapper - Mapping function that maps an {@link AssemblyTypes.AssemblyBoard} into additional board data\n   * @param options - Optional {@link ExtensionOptions} to control failure behavior.\n   *   Defaults to `failurePolicy: \"throw\"`, which throws an {@link ExtensionException} on mapper failure.\n   *   Set to `\"continue\"` to log the error and continue processing remaining mappers.\n   * @returns this instance for chaining\n   */\n  registerBoardDataMapper(\n    boardDataMapper: BoardDataMapper<any, any>,\n    options?: ExtensionOptions\n  ) {\n    ExtensionManager.dataMapper.registerDataMapper(\n      ExtensionType.BoardMapper,\n      boardDataMapper,\n      options\n    );\n    return this;\n  }\n\n  registerAssemblyFeatureFlagResolver(\n    assemblyFeatureFlagResolver: FlagResolver<AssemblyModel>\n  ) {\n    ExtensionManager[EXTENSION_FEATURE_FLAG_RESOLVER]?.register(\n      ExtensionType.AssemblyFeatureFlags,\n      assemblyFeatureFlagResolver\n    );\n    return this;\n  }\n}\n\n/**\n * The KosExtensionManager provides access to the extension points that are provided in the SDK for Dispense applications.\n *\n * The extension points are divided into two categories:\n *\n * @param core - The core extension {@link CoreExtensionManager}  points are used to extend the base models that are provided by the SDK.\n * @param dispense -  The dispense extension {@link DispenseExtensionManager} points are used to extend the models that are specific to the Dispense SDK.\n */\nexport class KosExtensionManager {\n  dispense: DispenseExtensionManager;\n  core: CoreExtensionManager;\n  constructor() {\n    this.dispense = new DispenseExtensionManager();\n    this.core = new CoreExtensionManager();\n  }\n}\n"],"names":["useState","useEffect","kosAutoEffect","CoreExtensionManager","ExtensionManager","ExtensionType","EXTENSION_FEATURE_FLAG_RESOLVER"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIO,MAAM,oBAAoB,CAAC,WAAwB;AACxD,QAAM,CAAC,WAAW,YAAY,IAAIA,MAAAA;AAAAA,IAChC,QAAQ,OAAO,YAAY;AAAA,EAAA;AAE7B,QAAM,CAAC,iBAAiB,kBAAkB,IAAIA,MAAAA;AAAAA,IAC5C,QAAQ,OAAO,gBAAgB;AAAA,EAAA;AAGjC,QAAM,CAAC,cAAc,eAAe,IAAIA,MAAAA;AAAAA,IACtC,QAAQ,OAAO,aAAa;AAAA,EAAA;AAG9B,QAAM,CAAC,oBAAoB,qBAAqB,IAAIA,MAAAA;AAAAA,IAClD,QAAQ,OAAO,iBAAiB;AAAA,EAAA;AAGlC,QAAM,CAAC,aAAa,cAAc,IAAIA,MAAAA;AAAAA,IACpC,mBAAmB,IACf,IACA,KAAK,OAAQ,mBAAmB,MAAM,aAAa,KAAM,GAAG;AAAA,EAAA;AAGlE,QAAM,CAAC,cAAc,eAAe,IAAIA,MAAAA;AAAAA,IACtC,gBAAgB;AAAA,EAAA;AAGlBC,QAAAA,UAAU,MAAM;AACd,UAAM,WAAWC,SAAAA,cAAc,MAAM;AACnC,mBAAa,QAAQ,OAAO,YAAY,CAAC;AACzC,yBAAmB,QAAQ,OAAO,gBAAgB,CAAC;AACnD,sBAAgB,QAAQ,OAAO,aAAa,MAAS;AACrD,4BAAsB,QAAQ,OAAO,iBAAiB,MAAS;AAC/D;AAAA,QACE,mBAAmB,IACf,IACA,KAAK,OAAQ,mBAAmB,MAAM,aAAa,KAAM,GAAG;AAAA,MAAA;AAElE,sBAAgB,gBAAgB,kBAAkB;AAAA,IACpD,CAAC;AAED,WAAO,MAAM;AACX,eAAA;AAAA,IACF;AAAA,EACF,GAAG,CAAC,MAAM,CAAC;AAEX,SAAO,EAAE,WAAW,iBAAiB,aAAa,aAAA;AACpD;ACkBO,MAAM,yBAAyB;AAAA,EACpC,OAA6B,IAAIC,SAAAA,qBAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcjC,6BACE,sBACA,SACA;AACAC,aAAAA,iBAAiB,WAAW;AAAA,MAC1BC,4BAAAA,cAAc;AAAA,MACd;AAAA,MACA;AAAA,IAAA;AAGF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,yBACE,kBACA,SACA;AACAD,aAAAA,iBAAiB,OAAO;AAAA,MACtBC,4BAAAA,cAAc;AAAA,MACd;AAAA,MACA;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA,EAEA,wBAAwB,iBAAiC;AACvDD,aAAAA,iBAAiB,eAAe;AAAA,MAC9BC,4BAAAA,cAAc;AAAA,MACd;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,6BACE,sBACA,SACA;AACAD,aAAAA,iBAAiB,eAAe;AAAA,MAC9BC,4BAAAA,cAAc;AAAA,MACd;AAAA,MACA;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,yBACE,kBACA,SACA;AACAD,aAAAA,iBAAiB,WAAW;AAAA,MAC1BC,4BAAAA,cAAc;AAAA,MACd;AAAA,MACA;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,yBACE,kBACA,SACA;AACAD,aAAAA,iBAAiB,eAAe;AAAA,MAC9BC,4BAAAA,cAAc;AAAA,MACd;AAAA,MACA;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,+BACE,kBACA,SACA;AACAD,aAAAA,iBAAiB,eAAe;AAAA,MAC9BC,4BAAAA,cAAc;AAAA,MACd;AAAA,MACA;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA,EAEA,oBACE,aACA;AACAD,aAAAA,iBAAiB,eAAe;AAAA,MAC9BC,4BAAAA,cAAc;AAAA,MACd;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,+BACE,oBACA,SACA;AACAD,aAAAA,iBAAiB,WAAW;AAAA,MAC1BC,4BAAAA,cAAc;AAAA,MACd;AAAA,MACA;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBA,2BACE,oBACA,SACA;AACAD,aAAAA,iBAAiB,OAAO;AAAA,MACtBC,4BAAAA,cAAc;AAAA,MACd;AAAA,MACA;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,mCACE,wBACA,SACA;AACAD,aAAAA,iBAAiB,WAAW;AAAA,MAC1BC,4BAAAA,cAAc;AAAA,MACd;AAAA,MACA;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA0BA,2BACE,oBACA,SACA;AACAD,aAAAA,iBAAiB,WAAW;AAAA,MAC1BC,4BAAAA,cAAc;AAAA,MACd;AAAA,MACA;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA,EAEA,mBAAmB,YAA4B;AAC7CD,aAAAA,iBAAiB,eAAe;AAAA,MAC9BC,4BAAAA,cAAc;AAAA,MACd;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,wBACE,iBACA,SACA;AACAD,aAAAA,iBAAiB,WAAW;AAAA,MAC1BC,4BAAAA,cAAc;AAAA,MACd;AAAA,MACA;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AAAA,EAEA,oCACE,6BACA;AACAD,aAAAA,iBAAiBE,SAAAA,+BAA+B,GAAG;AAAA,MACjDD,4BAAAA,cAAc;AAAA,MACd;AAAA,IAAA;AAEF,WAAO;AAAA,EACT;AACF;AAUO,MAAM,oBAAoB;AAAA,EAC/B;AAAA,EACA;AAAA,EACA,cAAc;AACZ,SAAK,WAAW,IAAI,yBAAA;AACpB,SAAK,OAAO,IAAIF,8BAAA;AAAA,EAClB;AACF;;;;;;;;;;;"}

package/{extension-utils-C_pwmFbZ.js → extension-utils-D_dnBLH6.js}

@@ -79,55 +79,18 @@ const getFuelGaugeValue = (holder) => {
 class DispenseExtensionManager {
   core = new CoreExtensionManager();
   /**
-   * Maps data into the {@link IngredientModel}
+   * Registers a data mapper for the {@link IngredientModel}.
    *
-   * It is common for the ingredient data provided by the ingredient service to be augmented with additional properties that are
-   * not provided by the base KOS Ingredient model. The {@link IngredientMapper} extension point allows for the data to be mapped
-   * into the {@link IngredientModel} and the {@link IngredientModel.data} property to be augmented with additional properties.
+   * Ingredient service data often needs properties the base model does not carry. The mapper receives each
+   * {@link IngredientResponse} and the data returned by the ingredient loader as context, and its result
+   * becomes the model's `data` property.
    *
    * @param ingredientDataMapper - Mapping function that maps an {@link IngredientResponse} into additional model data
    * @param options - Optional {@link ExtensionOptions} to control failure behavior.
    *   Defaults to `failurePolicy: "throw"`, which throws an {@link ExtensionException} on mapper failure.
    *   Set to `"continue"` to log the error and continue processing remaining mappers.
    * @returns this instance for chaining
-   *
-   * @example
-   * The following example shows how to map the data from the service response into the {@link IngredientModel}.
-   * The context is provided by the {@link IngredientLoader} extension point with its data being used to optionally augment the
-   * ingredient data.
-   *
-   * The result of the mapping will be available in the `data` property of the {@link IngredientModel}.
-   *
-   * In this case the `IngedientReponseData` interface represents the data being returned by the ingredient service and the
-   * `IngredientData` interface represents the data that will be available in the {@link IngredientModel.data} property.  The `ingredientDataMapper`
-   * is responsible for mapping from one format to the other.
-   *
-   * ```typescript
-   *
-   * interface IngredientResponseData extends NozzleServices.IngredientResponse {
-   *   chilled: boolean;
-   *   carbonated: boolean;
-   *   highYield: boolean;
-   * }
-   *
-   * interface IngredientData {
-   *   chilled: boolean;
-   *   carbonated: boolean;
-   *   highYield: boolean;
-   * }
-   *
-   * export const ingredientDataMapper = async (
-   * data: IngredientResponseData,
-   * context: IngredientContext
-   * ): Promise<IngredientData> => {
-   *  return {
-   *    chilled: data.chilled,
-   *    carbonated: data.carbonated,
-   *    highYield: data.highYield,
-   *  }
-   * }
-   * ```
-   * */
+   */
   registerIngredientDataMapper(ingredientDataMapper, options) {
     ExtensionManager.dataMapper.registerDataMapper(
       ExtensionType.IngredientMapper,
@@ -137,34 +100,14 @@ class DispenseExtensionManager {
     return this;
   }
   /**
-   * Loads data that will be provided as context into the {@link IngredientMapper}.
+   * Registers a loader whose result is passed as context to the ingredient data and type mappers.
    *
    * @param ingredientLoader - Async function that loads and returns ingredient context data
    * @param options - Optional {@link ExtensionOptions} to control failure behavior.
    *   Defaults to `failurePolicy: "throw"`, which throws an {@link ExtensionException} on loader failure.
    *   Set to `"continue"` to log the error and return `undefined` instead.
    * @returns this instance for chaining
-   *
-   * @example
-   * The following example shows how to load the brandset data, normalize it into a map and then provide it back to the framework
-   * where it can be used by the other extension points.
-   *
-   * In the ingredient container model, the data is provided to the {@link IngredientMapper} extension point in order to augment ingredient data
-   * and also loaded into the ingredient container model context in order to make the data available throughout the code.
-   *
-   * ```typescript
-   *  export const ingredientContextLoader = async (): Promise<BeverageContext> => {
-   *  const response = await kosFetch('kos:/system/some/ingredient/endpoint.json');
-   *
-   *   if (response.status !== 200) {
-   *     KosLog.error('Failed to load ingredient data');
-   *       return {};
-   *   }
-   *  const json = await response.json();
-   *  return json;
-   *  };
-   * ```
-   * */
+   */
   registerIngredientLoader(ingredientLoader, options) {
     ExtensionManager.loader.registerLoader(
       ExtensionType.IngredientLoader,
@@ -260,7 +203,10 @@ class DispenseExtensionManager {
     return this;
   }
   /**
-   * Maps data into the {@link AvailabilityModel}.
+   * Registers a data mapper for the {@link AvailabilityModel}.
+   *
+   * The mapper receives each availability node, with its `groupId`, and the data returned by the
+   * availability loader as context. Its result becomes the model's `data` property.
    *
    * @param availabilityMapper - Mapping function that maps a {@link GroupBeverageResponse} into additional availability data
    * @param options - Optional {@link ExtensionOptions} to control failure behavior.
@@ -269,28 +215,15 @@ class DispenseExtensionManager {
    * @returns this instance for chaining
    *
    * @example
-   * The following example shows how to map the data from the service response into the {@link AvailabilityModel}.
-   * The context is provided by the {@link AvailabilityLoader} extension point with its data being used to augment the
-   * availability data.
-   *
-   * The result of the mapping will be available in the `data` property of the {@link AvailabilityModel}.
-   *
    * ```typescript
-   * export const beverageDataMapper = async (
-   * data: NozzleServices.BeverageResponse,
-   * context: BeverageContext
-   * ): Promise<BeverageData> => {
-   *  const id = data.altId;
-   *  const iconUrl = encodeURI(
-   *    `http://localhost:8081/system/brandset/${context?.[id]?.icon}`
-   *  );
-   *  const cuiColorCode = context?.[id]?.cuiColorCode
-   *    ? context?.[id]?.cuiColorCode
-   *    : '';
-   *  return { iconUrl, cuiColorCode };
-   * };
+   * const beverageDataMapper: AvailabilityDataMapper<BeverageData> = async (
+   *   data,
+   *   context?: Record<string, BrandsetIngredient>
+   * ) => ({
+   *   iconUrl: context?.[data.altId]?.icon ?? "",
+   * });
    * ```
-   * */
+   */
   registerAvailabilityDataMapper(availabilityMapper, options) {
     ExtensionManager.dataMapper.registerDataMapper(
       ExtensionType.AvailabilityMapper,
@@ -300,7 +233,8 @@ class DispenseExtensionManager {
     return this;
   }
   /**
-   * Loads data that will be provided as context into the {@link AvailabilityMapper}.
+   * Registers a loader whose result is passed as context to the availability data mapper. A common use is
+   * loading UI-specific brandset data that the backend service does not provide.
    *
    * @param availabilityLoader - Async function that loads and returns availability context data
    * @param options - Optional {@link ExtensionOptions} to control failure behavior.
@@ -309,32 +243,14 @@ class DispenseExtensionManager {
    * @returns this instance for chaining
    *
    * @example
-   * A common use case is to load brandset data that is UI specific and not provided directly by the Java service.
-   *
-   * The following example shows how to load the brandset data, normalize it into a map and then provide it back to the framework
-   * where it can be used by the other extension points.
-   *
-   * In the nozzle model, the data is provided to the {@link AvailabilityMapper} extension point in order to augment availability data
-   * and also loaded into the nozzle model context in order to make the data available throughout the code.
-   *
    * ```typescript
-   *  export const beverageContextLoader = async (): Promise<BeverageContext> => {
-   *  const response = await kosFetch('kos:/system/brandset/brandset.json');
-   *
-   *   if (response.status !== 200) {
-   *     KosLog.error('Failed to load beverage data');
-   *       return {};
-   *   }
-   *   const json: BrandsetResponse | null = await response.json();
-   *   const initialBeverages: Record<string, BrandsetIngredient> = {};
-   *   const beverages = json?.ingredients?.reduce((acc, beverage) => {
-   *     acc[beverage.ingredientId] = beverage;
-   *     return acc;
-   *   }, initialBeverages);
-   *  return beverages;
-   *  };
+   * const beverageContextLoader = async () => {
+   *   const response = await kosFetch("kos:/system/brandset/brandset.json");
+   *   const json: BrandsetResponse = await response.json();
+   *   return Object.fromEntries(json.ingredients.map((i) => [i.ingredientId, i]));
+   * };
    * ```
-   * */
+   */
   registerAvailabilityLoader(availabilityLoader, options) {
     ExtensionManager.loader.registerLoader(
       ExtensionType.AvailabilityLoader,
@@ -361,9 +277,8 @@ class DispenseExtensionManager {
     return this;
   }
   /**
-   * Maps data into the {@link AssemblyModel} data.
-   * Used in cases where the base assembly has been extended with additional properties in the backend.  This extension
-   * point allows for the data to be mapped into the {@link AssemblyModel} and augmented with additional properties.
+   * Registers a data mapper for the {@link AssemblyModel}, for backends that extend the assembly response
+   * with additional properties. The mapper's result is merged into the assembly model.
    *
    * @param assemblyDataMapper - Mapping function that maps an {@link AssemblyTypes.AssemblyResponse} into additional assembly data
    * @param options - Optional {@link ExtensionOptions} to control failure behavior.
@@ -372,60 +287,18 @@ class DispenseExtensionManager {
    * @returns this instance for chaining
    *
    * @example
-   *
-   * In this example of an implementation of a {@link AssemblyMapper}, the {@link AssemblyResponse} data is mapped into
-   * a {@link FreestyleAssembly} object.
-   *
-   * The {@link FreestyleAssemblyResponse} interface represents the additional data being returned by the assembly service and is
-   * merged into the {@link AssemblyResponse} interface.
-   *
-   * The {@link FreestyleAssembly} interface represents the additional data, beyond the base data set, that will be merged into the {@link AssemblyModel}.
-   *
-   * The mapper is responsible for mapping from the {@link FreestyleAssemblyResponse} format to the {@link FreestyleAssembly} format.
    * ```typescript
-   *  import { AssemblyTypes } from "@kosdev-code/kos-dispense-sdk";
-   *  import { DataMapper } from "@kosdev-code/kos-ui-sdk";
-   *
-   *  // define the additional data being returned by the assembly service
-   *  export interface FreestyleAssemblyResponse {
-   *    iceAgitator?: {
-   *      name: "iceAgitator";
-   *      path: string;
-   *    };
-   *  }
-   *
-   *  // define the additional data structure that will be merged into the assembly model
-   *  export interface FreestyleAssembly {
-   *    iceAgitator: {
-   *      path: string;
-   *    };
-   *    carbAgitator: {
-   *      path: string;
-   *    };
-   *  }
-   *
-   *
-   *  // define the mapper that will map the data from the service response into the additional data structure
-   *  // that will be merged into the assembly model.
-   *  // In this case the mapper is responsible for mapping from the {@link FreestyleAssemblyResponse} format to the {@link FreestyleAssembly} format.
-   *  export const assemblyDataMapper: DataMapper<
-   *    AssemblyTypes.AssemblyResponse<FreestyleAssemblyResponse>,
-   *    FreestyleAssembly
-   *    > = async (data) => {
-   *    const response = data.assemblies.reduce((acc, assembly) => {
-   *      const agitatorKeys = ["iceAgitator", "carbAgitator"];
-   *      agitatorKeys.forEach((key) => {
-   *        const agitator = assembly[key];
-   *        if (agitator) {
-   *          acc[key] = agitator;
-   *        }
-   *      });
+   * interface IceAgitatorExt {
+   *   iceAgitator?: { name: string; path: string };
+   * }
    *
-   *      return acc;
-   *    }, {} as FreestyleAssembly);
-   *    return response;
-   *  };
-   *```
+   * const assemblyDataMapper: AssemblyMapper<
+   *   { iceAgitatorPath?: string },
+   *   AssemblyTypes.AssemblyResponse<{ AssemblyExt: IceAgitatorExt }>
+   * > = async (data) => ({
+   *   iceAgitatorPath: data.assemblies.find((a) => a.iceAgitator)?.iceAgitator?.path,
+   * });
+   * ```
    */
   registerAssemblyDataMapper(assemblyDataMapper, options) {
     ExtensionManager.dataMapper.registerDataMapper(
@@ -487,4 +360,4 @@ export {
   getFuelGaugeValue as g,
   index$3 as i
 };
-//# sourceMappingURL=extension-utils-C_pwmFbZ.js.map
+//# sourceMappingURL=extension-utils-D_dnBLH6.js.map