@sutton-signwriting/core/src/types.js

a javascript package for node and browsers that supports general processing of the Sutton SignWriting script

/**
 * Object of query elements with regular expression identification.
 * @typedef {object} QueryObject
 * @property {boolean} query - required true for query object
 * @property {object} [prefix] - an object for prefix elements
 * @property {boolean} prefix.required - true if sorting prefix is required
 * @property {(string|string[]|(string|string[])[])[]} [prefix.parts] - array of symbol strings, range arrays, and OR arrays of strings and range arrays
 * @property {(QuerySignboxSymbol|QuerySignboxRange|QuerySignboxOr)[]} [signbox] - array of objects for symbols, ranges, and list of symbols or ranges, with optional coordinates
 * @property {number} [variance] - amount that x or y coordinates can vary and find a match, defaults to 20
 * @property {boolean} [style] - boolean value for including style string in matches
 */

/**
 * @typedef {object} QuerySignboxSymbol
 * @property {string} symbol - a symbol
 * @property {number[]} [coord] - an optional coordinate
 */

/**
 * @typedef {object} QuerySignboxRange
 * @property {string[]} range - an array of two symbols
 * @property {number[]} [coord] - an optional coordinate
 */

/**
 * @typedef {object} QuerySignboxOr
 * @property {(string|string[])[]} or - an array of symbol strings and range arrays
 * @property {number[]} [coord] - an optional coordinate
 */

/**
 * @typedef {object} ColumnOptions
 * @property {number} [height] - the height of the columns
 * @property {number} [width] - the widths of the columns
 * @property {number} [offset] - the lane offset for left and right lanes
 * @property {number} [pad] - amount of padding before and after signs as well as at top, left, and right of columns
 * @property {number} [margin] - amount of space at bottom of column that is not available
 * @property {boolean} [dynamic] - enables variable width columns
 * @property {string} [background] - background color for columns
 * @property {StyleObject} [style] - an object of style options
 * @property {object} [punctuation] - an object of punctuation options
 * @property {boolean} [punctuation.spacing] - enables special spacing for punctuation with no space above and custom space below
 * @property {number} [punctuation.pad] - the amount of spacing after a punctuation if punctuation spacing is enabled
 * @property {boolean} [punctuation.pull] - prevents line breaks before punctuation by reducing spacing between signs in a column
 */

/**
 * @typedef {ColumnSegment[]} ColumnData
 */

/**
 * @typedef {object} ColumnSegment
 * @property {number} x - the x position in the column
 * @property {number} y - the y position in the column
 * @property {number} minX - the min x value within the segment
 * @property {number} minY - the min y value within the segment
 * @property {number} width - the width of the text segment
 * @property {number} height - the height of the text segment
 * @property {number} lane - Left as -1, Middle as 0, Right as 1
 * @property {number} padding - the padding of the text segment affects colored background
 * @property {string} segment - "sign" or "symbol"
 * @property {string} text - the text of the sign or symbol with optional style string
 * @property {number} zoom - the zoom size of the segment
 */

/**
 * @typedef {object} SegmentInfo
 * @property {number} minX - the min x value within the segment
 * @property {number} minY - the min y value within the segment
 * @property {number} width - the width of the text segment
 * @property {number} height - the height of the text segment
 * @property {number} lane - Left as -1, Middle as 0, Right as 1
 * @property {number} padding - the padding of the text segment affects colored background
 * @property {string} segment - "sign" or "symbol"
 * @property {number} zoom - the zoom size of the segment
 */

/**
 * The elements of a style string
 * @typedef {object} StyleObject
 * @property {boolean} [colorize] - boolean to use standardized colors for symbol groups
 * @property {number} [padding] - integer value for padding around symbol or sign
 * @property {string} [background] - css name or hex color for background
 * @property {string[]} [detail] - array for css name or hex color for line and optional fill
 * @property {number} [zoom] - decimal value for zoom level
 * @property {object[]} [detailsym] - custom colors for individual symbols
 * @property {number} detailsym.index - symbol index in sign box
 * @property {string[]} detailsym.detail - array for css name or hex color for line and optional fill
 * @property {string} [classes] - list of class names separated with spaces used for SVG
 * @property {string} [id] - id name used for SVG
 */

/**
 * The elements of a symbol string
 * @typedef {object} SymbolObject
 * @property {string} [symbol] - symbol identifier
 * @property {number[]} [coord] - x,y coordinate
 * @property {string} [style] - style string
 */

/**
 * The elements of a sign string
 * @typedef {object} SignObject
 * @property {string[]} [sequence] - array of symbols
 * @property {string} [box] - signbox marker or lane
 * @property {number[]} [max] - preprocessed x,y coordinate
 * @property {{symbol: string, coord: number[]}[]} [spatials] - array of symbols with coordinates
 * @property {string} [style] - style string
 */

/**
 * @typedef {Object} TokenizerObject
 * @property {Object} i2s - Index to string mapping
 * @property {Object} s2i - String to index mapping
 * @property {number} length - Total number of tokens
 * @property {Function} vocab - Returns array of all tokens
 * @property {Function} encode - Encodes a string of SignWriting to token indices
 * @property {Function} decode - Decodes token indices to a string of SignWriting
 * @property {Function} encodeTokens - Encodes an array of token strings to token indices
 * @property {Function} decodeTokens - Decodes an array of token indices to token strings
 */