Class SnapProcessor

Hierarchy (View Summary)

BaseProcessor
- SnapProcessor

Index

Constructors

Properties

Methods

addAudioToButton addToExtractedMap createAudioEnhancedPageset extractButtonsForAudio extractStringsWithMetadata extractStringsWithMetadataGeneric extractTexts filterPageButtons generateTranslatedDownload generateTranslatedDownloadGeneric generateTranslatedOutputPath loadIntoTree processTexts saveFromTree shouldFilterButton validate

Constructors

constructor

new SnapProcessor(
    symbolResolver?: unknown,
    options?: ProcessorOptions & {
        loadAudio?: boolean;
        pageLayoutPreference?: number | "largest" | "smallest" | "scanning";
    },
): SnapProcessor
Parameters
- symbolResolver: unknown = null
- options: ProcessorOptions & {
  loadAudio?: boolean;
  pageLayoutPreference?: number | "largest" | "smallest" | "scanning";
  } = {}
Returns SnapProcessor
Overrides BaseProcessor.constructor
- Defined in src/processors/snapProcessor.ts:56

Properties

`Protected`options

options: ProcessorOptions

Methods

addAudioToButton

addAudioToButton(
    dbPath: string,
    buttonId: number,
    audioData: Buffer,
    metadata?: string,
): number
Add audio recording to a button in the database
Parameters
- dbPath: string
- buttonId: number
- audioData: Buffer
- Optionalmetadata: string
Returns number
- Defined in src/processors/snapProcessor.ts:869

`Protected`addToExtractedMap

addToExtractedMap(
    extractedMap: Map<string, ExtractedString>,
    key: string,
    originalString: string,
    vocabLocation: VocabLocation,
): void
Helper method to add extracted strings to the map, handling duplicates
Parameters
- extractedMap: Map<string, ExtractedString>
  Map to store extracted strings
- key: string
  Lowercase key for deduplication
- originalString: string
  Original string with proper casing
- vocabLocation: VocabLocation
  Metadata about where the string was found
Returns void
Inherited from BaseProcessor.addToExtractedMap
- Defined in src/core/baseProcessor.ts:377

createAudioEnhancedPageset

createAudioEnhancedPageset(
    sourceDbPath: string,
    targetDbPath: string,
    audioMappings: Map<number, { audioData: Buffer; metadata?: string }>,
): void
Create a copy of the pageset with audio recordings added
Parameters
- sourceDbPath: string
- targetDbPath: string
- audioMappings: Map<number, { audioData: Buffer; metadata?: string }>
Returns void
- Defined in src/processors/snapProcessor.ts:918

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 }[]
- Defined in src/processors/snapProcessor.ts:935

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>
Overrides BaseProcessor.extractStringsWithMetadata
- Defined in src/processors/snapProcessor.ts:989

`Protected`extractStringsWithMetadataGeneric

extractStringsWithMetadataGeneric(
filePath: string,
): Promise<ExtractStringsResult>
Generic implementation for extracting strings with metadata Can be used by any processor that doesn't need format-specific logic
Parameters
- filePath: string
  Path to the AAC file
Returns Promise<ExtractStringsResult>
Promise with extracted strings and metadata
Inherited from BaseProcessor.extractStringsWithMetadataGeneric
- Defined in src/core/baseProcessor.ts:254

extractTexts

extractTexts(filePathOrBuffer: string | Buffer): string[]
Parameters
- filePathOrBuffer: string | Buffer
Returns string[]
Overrides BaseProcessor.extractTexts
- Defined in src/processors/snapProcessor.ts:70

`Protected`filterPageButtons

filterPageButtons(buttons: AACButton[]): AACButton[]
Parameters
- buttons: AACButton[]
Returns AACButton[]
Inherited from BaseProcessor.filterPageButtons
- Defined in src/core/baseProcessor.ts:244

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>
Overrides BaseProcessor.generateTranslatedDownload
- Defined in src/processors/snapProcessor.ts:997

`Protected`generateTranslatedDownloadGeneric

generateTranslatedDownloadGeneric(
    filePath: string,
    translatedStrings: TranslatedString[],
    sourceStrings: SourceString[],
): Promise<string>
Generic implementation for generating translated downloads Can be used by any processor that doesn't need format-specific logic
Parameters
- filePath: string
  Path to the original AAC file
- translatedStrings: TranslatedString[]
  Array of translated string data
- sourceStrings: SourceString[]
  Array of source string data
Returns Promise<string>
Promise with path to the generated translated file
Inherited from BaseProcessor.generateTranslatedDownloadGeneric
- Defined in src/core/baseProcessor.ts:331

`Protected`generateTranslatedOutputPath

generateTranslatedOutputPath(filePath: string): string
Generate output path for translated file based on input file extension
Parameters
- filePath: string
  Original file path
Returns string
Path for the translated output file
Inherited from BaseProcessor.generateTranslatedOutputPath
- Defined in src/core/baseProcessor.ts:401

loadIntoTree

loadIntoTree(filePathOrBuffer: string | Buffer): AACTree
Parameters
- filePathOrBuffer: string | Buffer
Returns AACTree
Overrides BaseProcessor.loadIntoTree
- Defined in src/processors/snapProcessor.ts:89

processTexts

processTexts(
    filePathOrBuffer: string | Buffer,
    translations: Map<string, string>,
    outputPath: string,
): Buffer
Parameters
- filePathOrBuffer: string | Buffer
- translations: Map<string, string>
- outputPath: string
Returns Buffer
Overrides BaseProcessor.processTexts
- Defined in src/processors/snapProcessor.ts:602

saveFromTree

saveFromTree(tree: AACTree, outputPath: string): void
Parameters
- tree: AACTree
- outputPath: string
Returns void
Overrides BaseProcessor.saveFromTree
- Defined in src/processors/snapProcessor.ts:642

`Protected`shouldFilterButton

shouldFilterButton(button: AACButton): boolean
Parameters
- button: AACButton
Returns boolean
Inherited from BaseProcessor.shouldFilterButton
- Defined in src/core/baseProcessor.ts:170

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
Overrides BaseProcessor.validate
- Defined in src/processors/snapProcessor.ts:1010

Class SnapProcessor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SnapProcessor

Properties

Protectedoptions

Methods

addAudioToButton

Parameters

Returns number

ProtectedaddToExtractedMap

Parameters

Returns void

createAudioEnhancedPageset

Parameters

Returns void

extractButtonsForAudio

Parameters

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

extractStringsWithMetadata

Parameters

Returns Promise<ExtractStringsResult>

ProtectedextractStringsWithMetadataGeneric

Parameters

Returns Promise<ExtractStringsResult>

extractTexts

Parameters

Returns string[]

ProtectedfilterPageButtons

Parameters

Returns AACButton[]

generateTranslatedDownload

Parameters

Returns Promise<string>

ProtectedgenerateTranslatedDownloadGeneric

Parameters

Returns Promise<string>

ProtectedgenerateTranslatedOutputPath

Parameters

Returns string

loadIntoTree

Parameters

Returns AACTree

processTexts

Parameters

Returns Buffer

saveFromTree

Parameters

Returns void

ProtectedshouldFilterButton

Parameters

Returns boolean

validate

Parameters

Returns Promise<ValidationResult>

Settings

On This Page

`Protected`options

`Protected`addToExtractedMap

`Protected`extractStringsWithMetadataGeneric

`Protected`filterPageButtons

`Protected`generateTranslatedDownloadGeneric

`Protected`generateTranslatedOutputPath

`Protected`shouldFilterButton