Class SnapProcessor

constructor

• new SnapProcessor(
      symbolResolver?: unknown,
      options?: Partial<ProcessorConfig> & {
          loadAudio?: boolean;
          pageLayoutPreference?: number | "largest" | "smallest" | "scanning";
      },
  ): SnapProcessor

  Parameters

  • symbolResolver: unknown = null
  • Optionaloptions: Partial<ProcessorConfig> & {
        loadAudio?: boolean;
        pageLayoutPreference?: number | "largest" | "smallest" | "scanning";
    }

  Returns SnapProcessor

Readonlycapabilities

addAudioToButton

• addAudioToButton(
      dbPath: string,
      buttonId: number,
      audioData: Uint8Array,
      metadata?: string,
  ): Promise<number>

  Add audio recording to a button in the database

  Parameters

  • dbPath: string
  • buttonId: number
  • audioData: Uint8Array
  • Optionalmetadata: string

  Returns Promise<number>

createAudioEnhancedPageset

• createAudioEnhancedPageset(
      sourceDbPath: string,
      targetDbPath: string,
      audioMappings: Map<number, { audioData: Uint8Array; metadata?: string }>,
  ): Promise<void>

  Create a copy of the pageset with audio recordings added

  Parameters

  • sourceDbPath: string
  • targetDbPath: string
  • audioMappings: Map<number, { audioData: Uint8Array; metadata?: string }>

  Returns Promise<void>

extractButtonsForAudio

• extractButtonsForAudio(
      dbPath: string,
      pageUniqueId: string,
  ): { hasAudio: boolean; id: number; label: string; message: string }[]

  Extract buttons from a specific page that need audio recordings

  Parameters

  • dbPath: string
  • pageUniqueId: string

  Returns { hasAudio: boolean; id: number; label: string; message: string }[]

extractStringsWithMetadata

• extractStringsWithMetadata(filePath: string): Promise<ExtractStringsResult>

  Extract strings with metadata for aac-tools-platform compatibility Uses the generic implementation from BaseProcessor

  Parameters

  • filePath: string

  Returns Promise<ExtractStringsResult>

extractTexts

• extractTexts(filePathOrBuffer: ProcessorInput): Promise<string[]>

  Parameters

  • filePathOrBuffer: ProcessorInput

  Returns Promise<string[]>

generateTranslatedDownload

• generateTranslatedDownload(
      filePath: string,
      translatedStrings: TranslatedString[],
      sourceStrings: SourceString[],
  ): Promise<string>

  Generate translated download for aac-tools-platform compatibility Uses the generic implementation from BaseProcessor

  Parameters

  • filePath: string
  • translatedStrings: TranslatedString[]
  • sourceStrings: SourceString[]

  Returns Promise<string>

getAvailablePageLayouts

• getAvailablePageLayouts(filePath: string): Promise<PageLayoutInfo[]>

  Get available PageLayouts for a Snap file Useful for UI components that want to let users select layout size

  Parameters

  • filePath: string

    Path to the Snap file

  Returns Promise<PageLayoutInfo[]>

  Promise resolving to available PageLayouts with their dimensions

loadIntoTree

• loadIntoTree(filePathOrBuffer: ProcessorInput): Promise<AACTree>

  Parameters

  • filePathOrBuffer: ProcessorInput

  Returns Promise<AACTree>

processTexts

• processTexts(
      filePathOrBuffer: ProcessorInput,
      translations: Map<string, string>,
      outputPath: string,
  ): Promise<Uint8Array>

  Parameters

  • filePathOrBuffer: ProcessorInput
  • translations: Map<string, string>
  • outputPath: string

  Returns Promise<Uint8Array>

saveFromTree

• saveFromTree(tree: AACTree, outputPath: string): Promise<void>

  Parameters

  • tree: AACTree
  • outputPath: string

  Returns Promise<void>

saveModifiedTree

• saveModifiedTree(
      originalPath: string,
      tree: AACTree,
      outputPath: string,
  ): Promise<void>

  Save a modified tree while preserving the original SQLite schema and data.

  Strategy: copy the original .sps verbatim, then open the copy and replay page.pendingMutations as targeted SQL UPDATE/INSERT statements. Everything not in the mutation log (PageLayout, ScanGroup, image blobs, ContentTypeData, ButtonPageLink, etc.) is preserved byte-for-byte from the original.

  This is the asset-preserving counterpart to saveFromTree (which builds a stripped-down DB from scratch and is unsuitable for round-tripping real TD Snap page sets).

  Supported mutations:

  • updateButton(id, patch) → UPDATE Button SET Label/Message WHERE Id = ?
  • removeButton(id) → UPDATE ElementPlacement SET Visible = 0 for all placements pointing at the button's ElementReference
  • addButton(button) → INSERT into ElementReference + Button + one ElementPlacement per existing PageLayout for the target page (so the button shows in every layout the user has). Image/audio not yet handled.

  WordList mutations are no-ops on Snap (capabilities.wordList === 'none').

  Parameters

  • originalPath: string
  • tree: AACTree
  • outputPath: string

  Returns Promise<void>

validate

• validate(filePath: string): Promise<ValidationResult>

  Validate Snap file format

  Parameters

  • filePath: string

    Path to the file to validate

  Returns Promise<ValidationResult>

  Promise with validation result