# ISIS v2 HUD Element Pack SDK End-to-End Examples

Generated: 2026-03-01T17:36:36.325Z Checklist: `MXA-0316` (ISIS2-00514) Asset
Family: `hud-element-pack` Phase: Phase 4 | Milestone: M3 Launch (2026-07-27 to
2026-10-30)

## Objective

Expose hud-element-pack workflows via @isis/client with typed SDK request
contracts and end-to-end example builders covering direct runs, chained
orchestration, and batch variants.

## Typed Workflow Contracts

| Workflow ID                            | Generation Type | Required Parameters                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| -------------------------------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `hud-element-pack-baseline`            | `text-to-image` | `hud_layout_type`, `display_context`, `hud_style_family`, `information_density`, `visual_hierarchy_profile`, `typography_profile`, `safe_frame_profile`, `anchor_system`, `interaction_mode`, `state_variant`, `contrast_target`, `background_mode`, `color_palette_profile`, `platform_target`, `render_intent`, `checkpoint_id`, `prompt_template_id`, `style_profile_id`, `color_script`, `seed`, `width`, `height`, `steps`, `cfg_scale`                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `hud-element-pack-image-conditioned`   | `text-to-image` | `style_reference_image`, `use_composition_reference`, `reference_strength`, `composition_strength`, `hud_layout_type`, `display_context`, `hud_style_family`, `information_density`, `visual_hierarchy_profile`, `typography_profile`, `safe_frame_profile`, `anchor_system`, `interaction_mode`, `state_variant`, `contrast_target`, `background_mode`, `color_palette_profile`, `platform_target`, `render_intent`, `checkpoint_id`, `prompt_template_id`, `style_profile_id`, `color_script`, `style_preset`, `seed`, `width`, `height`, `steps`, `cfg_scale`                                                                                                                                                                                                                                                                                                                                    |
| `hud-element-pack-control-conditioned` | `text-to-image` | `use_pose_control`, `use_depth_control`, `use_segmentation_control`, `pose_strength`, `depth_strength`, `segmentation_strength`, `hud_layout_type`, `display_context`, `hud_style_family`, `information_density`, `visual_hierarchy_profile`, `typography_profile`, `safe_frame_profile`, `anchor_system`, `interaction_mode`, `state_variant`, `contrast_target`, `background_mode`, `color_palette_profile`, `platform_target`, `render_intent`, `checkpoint_id`, `prompt_template_id`, `style_profile_id`, `color_script`, `style_preset`, `seed`, `width`, `height`, `steps`, `cfg_scale`                                                                                                                                                                                                                                                                                                       |
| `hud-element-pack-consistency-locked`  | `text-to-image` | `continuity_profile_id`, `continuity_profile_revision`, `continuity_locked_dimensions`, `scene_profile_id`, `style_profile_id`, `checkpoint_id`, `prompt_template_id`, `color_script`, `lens_profile`, `scene_anchor_reference_image`, `use_scene_anchor_reference`, `use_layout_reference`, `use_lighting_reference`, `use_lens_reference`, `use_style_lock`, `hud_layout_type`, `display_context`, `hud_style_family`, `information_density`, `visual_hierarchy_profile`, `typography_profile`, `safe_frame_profile`, `anchor_system`, `interaction_mode`, `state_variant`, `contrast_target`, `background_mode`, `color_palette_profile`, `platform_target`, `render_intent`, `hud_viewport_scale`, `style_preset`, `seed`, `width`, `height`, `steps`, `cfg_scale`, `scene_anchor_lock_strength`, `layout_lock_strength`, `lighting_lock_strength`, `lens_lock_strength`, `style_lock_strength` |

## SDK Surface Checks

| Category          | Method                                  | Present |
| ----------------- | --------------------------------------- | ------- |
| workflow-resource | `runHudElementPack`                     | true    |
| workflow-resource | `runHudElementPackBaseline`             | true    |
| workflow-resource | `runHudElementPackImageConditioned`     | true    |
| workflow-resource | `runHudElementPackControlConditioned`   | true    |
| workflow-resource | `runHudElementPackConsistencyLocked`    | true    |
| client-shortcut   | `runHudElementPackBaseline`             | true    |
| client-shortcut   | `runHudElementPackImageConditioned`     | true    |
| client-shortcut   | `runHudElementPackControlConditioned`   | true    |
| client-shortcut   | `runHudElementPackConsistencyLocked`    | true    |
| examples-module   | `createHudElementPackEndToEndExamples`  | true    |
| examples-module   | `executeHudElementPackEndToEndExamples` | true    |

## Verification Commands

- `pnpm --filter @isis/client exec vitest run src/resources/workflows.hud-element-pack.spec.ts src/examples/hud-element-pack.spec.ts`
- `pnpm nx build @isis/client`

## Acceptance Criteria

- SDK exposes typed run methods for baseline, image-conditioned,
  control-conditioned, and consistency-locked hud-element-pack workflows.
- SDK runtime validation rejects invalid generation types and malformed variant
  parameters before transport dispatch.
- SDK exports end-to-end examples for direct runs plus chain and batch
  orchestration payloads.
- SDK root exports and client shortcut methods expose the hud-element-pack
  workflow surface for downstream consumers.

## Traceability

- Checklist item: `MXA-0316`
- Ticket key: `ISIS2-00514`
- Source references:
  - `docs/domains/isis/remediation-v2/ISIS_REMEDIATION_V2_TICKETS.json`
  - `docs/domains/isis/remediation-v2/ISIS_V2_HUD_ELEMENT_PACK_REQUIREMENTS_BRIEF.json`
  - `docs/domains/isis/remediation-v2/ISIS_V2_HUD_ELEMENT_PACK_GENERATION_API_TYPED_REQUEST_CONTRACTS.json`
  - `libs/isis/client/src/resources/workflows.ts`
  - `libs/isis/client/src/resources/workflows.hud-element-pack.spec.ts`
  - `libs/isis/client/src/examples/hud-element-pack.ts`
  - `libs/isis/client/src/examples/hud-element-pack.spec.ts`
  - `libs/isis/client/src/client.ts`
  - `libs/isis/client/src/index.ts`
  - `libs/isis/client/src/resources/index.ts`
  - `ISIS_TODOS_2.md`
