@ibgib/helper-gib
Version:
common helper/utils/etc used in ibgib libs. Node v19+ needed for heavily-used isomorphic webcrypto hashing consumed in both node and browsers.
1,038 lines (1,037 loc) • 39.7 kB
text/typescript
export declare class SsmlTypes {
/**
* Describes how the text should be interpreted. This lets you
* provide additional context to the text and eliminate any
* ambiguity on how Alexa should render the text. Indicate how
* Alexa should interpret the text with the interpret-as attribute.
*
* Note that the Alexa service attempts to interpret the provided
* text correctly based on the text’s formatting even without this
* tag. For example, if your output speech includes “202-555-1212”,
* Alexa speaks each individual digit, with a brief pause for each
* dash. You don’t need to use <say-as interpret-as="telephone"> in
* this case. However, if you provided the text “2025551212”, but
* you wanted Alexa to speak it as a phone number, you would need
* to use <say-as interpret-as="telephone">.
*
* @example
* <speak>
* Here is a number spoken as a cardinal number:
* <say-as interpret-as="cardinal">12345</say-as>.
* Here is the same number with each digit spoken separately:
* <say-as interpret-as="digits">12345</say-as>.
* Here is a word spelled out: <say-as interpret-as="spell-out">hello</say-as>
* </speak>
*
* @see
* https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#say-as
*/
static sayAs({ text, interpret, format }: {
/**
* Text to specify interpretation.
*/
text: string;
/**
* Value that indicates how text should be interpreted.
*
* @see {InterpretAs}
*/
interpret: InterpretAs;
/**
* Only used when interpret-as is set to date. Set to one of
* the following to indicate format of the date:
*
* mdy
* dmy
* ymd
* md
* dm
* ym
* my
* d
* m
* y
*
* Alternatively, if you provide the date in YYYYMMDD format,
* the format attribute is ignored. You can include question
* marks (?) for portions of the date to leave out. For
* instance, Alexa would speak <say-as interpret-as="date">????
* 0922</say-as> as “September 22nd”.
*/
format?: SayAsDate;
}): string;
}
export type InterpretAs = "characters" | "spell-out" | "cardinal" | "number" | "ordinal" | "digits" | "fraction" | "unit" | "date" | "time" | "telephone" | "address" | "interjection" | "expletive";
/**
* Values that indicate how Alexa should speak text.
* To be used with Ssml.sayAs({text, interpret: As.characters})
*/
export declare const As: {
/**
* Spell out each letter.
*/
characters: string;
/**
* Spell out each letter.
*/
spell_out: InterpretAs;
/**
* Interpret the value as a cardinal number.
*
* @example "12" is pronounced as "twelve" and not "1-2".
*/
cardinal: InterpretAs;
/**
* Interpret the value as a cardinal number.
*
* @example "12" is pronounced as "twelve" and not "1-2".
*/
number: InterpretAs;
/**
* Interpret the value as an ordinal number.
*
* @example "12" is pronounced as "twelfth"
*/
ordinal: InterpretAs;
/**
* Spell each digit separately.
*/
digits: InterpretAs;
/**
* Interpret the value as a fraction. This works for both common
* fractions (such as 3/20) and mixed fractions (such as 1+1/2).
*/
fraction: InterpretAs;
/**
* Interpret a value as a measurement. The value should be either a
* number or fraction followed by a unit (with no space in between)
* or just a unit.
*/
unit: InterpretAs;
/**
* Interpret the value as a date. Specify the format with the
* format attribute.
*/
date: InterpretAs;
/**
* Interpret a value such as 1'21" as duration in minutes and
* seconds.
*/
time: InterpretAs;
/**
* Interpret a value as a 7-digit or 10-digit telephone number.
* This can also handle extensions (for example, 2025551212x345).
*/
telephone: InterpretAs;
/**
* Interpret a value as part of street address.
*/
address: InterpretAs;
/**
* askGib NOTE: SpeechCons are already implemented directly: e.g. `Ssml.speech(Con.abracadabra)`
*
* Interpret the value as an interjection. Alexa speaks the text in
* a more expressive voice. For optimal results, only use the
* supported interjections and surround each one with a pause. For
*
* @example
* <say-as interpret-as="interjection">Wow.</say-as>.
*
* Speechcons are supported for English (US), English (UK), and
* German.
*/
interjection: InterpretAs;
/**
* “Bleep” out the content inside the tag.
*/
expletive: InterpretAs;
};
export type SayAsDate = "mdy" | "dmy" | "ymd" | "md" | "dm" | "ym" | "my" | "d" | "m" | "y";
/**
* Date formats, used with @see {sayAs} function when
* @see {InterpretAs} is "date".
*
* Alternatively, if you provide the date in YYYYMMDD format, the
* format attribute is ignored. You can include question marks (?) for
* portions of the date to leave out. For instance, Alexa would speak
* <say-as interpret-as="date">????0922</say-as> as “September 22nd”.
*/
export declare const SayAsDate: {
mdy: SayAsDate;
dmy: SayAsDate;
ymd: SayAsDate;
md: SayAsDate;
dm: SayAsDate;
ym: SayAsDate;
my: SayAsDate;
d: SayAsDate;
m: SayAsDate;
y: SayAsDate;
};
export type ProsodyRateType = "x-slow" | "slow" | "medium" | "fast" | "x-fast" | number;
export type ProsodyPitchType = "x-low" | "low" | "medium" | "high" | "x-high" | number;
export type ProsodyVolumeType = "silent" | "x-soft" | "soft" | "medium" | "loud" | "x-loud" | number;
export type SpeechCon = "abracadabra" | "achoo" | "aha" | "ahem" | "ahoy" | "all righty" | "aloha" | "aooga" | "argh" | "arrivederci" | "as you wish" | "attagirl" | "au revoir" | "avast ye" | "aw man" | "baa" | "bada bing bada boom" | "bah humbug" | "bam" | "bang" | "batter up" | "bazinga" | "beep beep" | "bingo" | "blah" | "blarg" | "blast" | "boing" | "bon appetit" | "bonjour" | "bon voyage" | "boo" | "boo hoo" | "boom" | "booya" | "bravo" | "bummer" | "caw" | "cha ching" | "checkmate" | "cheerio" | "cheers" | "cheer up" | "chirp" | "choo choo" | "clank" | "click clack" | "cock a doodle doo" | "coo" | "cowabunga" | "darn" | "ding dong" | "ditto" | "d’oh" | "dot dot dot" | "duh" | "dum" | "dun dun dun" | "dynomite" | "eek" | "eep" | "encore" | "en gard" | "eureka" | "fancy that" | "geronimo" | "giddy up" | "good grief" | "good luck" | "good riddance" | "gotcha" | "great scott" | "heads up" | "hear hear" | "hip hip hooray" | "hiss" | "honk" | "howdy" | "hurrah" | "hurray" | "huzzah" | "jeepers creepers" | "jiminy cricket" | "jinx" | "just kidding" | "kaboom" | "kablam" | "kaching" | "kapow" | "katchow" | "kazaam" | "kerbam" | "kerboom" | "kerching" | "kerchoo" | "kerflop" | "kerplop" | "kerplunk" | "kerpow" | "kersplat" | "kerthump" | "knock knock" | "le sigh" | "look out" | "mamma mia" | "man overboard" | "mazel tov" | "meow" | "merci" | "moo" | "nanu nanu" | "neener neener" | "no way" | "now now" | "oh boy" | "oh brother" | "oh dear" | "oh my" | "oh snap" | "oink" | "okey dokey" | "oof" | "ooh la la" | "open sesame" | "ouch" | "oy" | "phew" | "phooey" | "ping" | "plop" | "poof" | "pop" | "pow" | "quack" | "read ‘em and weep" | "ribbit" | "righto" | "roger" | "ruh roh" | "shucks" | "splash" | "spoiler alert" | "squee" | "swish" | "swoosh" | "ta da" | "ta ta" | "tee hee" | "there there" | "thump" | "tick tick tick" | "tick-tock" | "touche" | "tsk tsk" | "tweet" | "uh huh" | "uh oh" | "um" | "voila" | "vroom" | "wahoo" | "wah wah" | "watch out" | "way to go" | "well done" | "well well" | "wham" | "whammo" | "whee" | "whew" | "woof" | "whoops a daisy" | "whoosh" | "woo hoo" | "wow" | "wowza" | "wowzer" | "yadda yadda yadda" | "yay" | "yikes" | "yippee" | "yoink" | "yoo hoo" | "you bet" | "yowza" | "yowzer" | "yuck" | "yum" | "zap" | "zing" | "zoinks";
/**
* Special interjections that Alexa can say.
* I have this called only "Con" for readability of calling code.
*
* https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speechcon-reference
*
* All spaces in keys are replaced with underscores.
*/
export declare const Con: {
abracadabra: SpeechCon;
achoo: SpeechCon;
aha: SpeechCon;
ahem: SpeechCon;
ahoy: SpeechCon;
all_righty: SpeechCon;
aloha: SpeechCon;
aooga: SpeechCon;
argh: SpeechCon;
arrivederci: SpeechCon;
as_you_wish: SpeechCon;
attagirl: SpeechCon;
au_revoir: SpeechCon;
avast_ye: SpeechCon;
aw_man: SpeechCon;
baa: SpeechCon;
bada_bing_bada_boom: SpeechCon;
bah_humbug: SpeechCon;
bam: SpeechCon;
bang: SpeechCon;
batter_up: SpeechCon;
bazinga: SpeechCon;
beep_beep: SpeechCon;
bingo: SpeechCon;
blah: SpeechCon;
blarg: SpeechCon;
blast: SpeechCon;
boing: SpeechCon;
bon_appetit: SpeechCon;
bonjour: SpeechCon;
bon_voyage: SpeechCon;
boo: SpeechCon;
boo_hoo: SpeechCon;
boom: SpeechCon;
booya: SpeechCon;
bravo: SpeechCon;
bummer: SpeechCon;
caw: SpeechCon;
cha_ching: SpeechCon;
checkmate: SpeechCon;
cheerio: SpeechCon;
cheers: SpeechCon;
cheer_up: SpeechCon;
chirp: SpeechCon;
choo_choo: SpeechCon;
clank: SpeechCon;
click_clack: SpeechCon;
cock_a_doodle_doo: SpeechCon;
coo: SpeechCon;
cowabunga: SpeechCon;
darn: SpeechCon;
ding_dong: SpeechCon;
ditto: SpeechCon;
doh: SpeechCon;
dot_dot_dot: SpeechCon;
duh: SpeechCon;
dum: SpeechCon;
dun_dun_dun: SpeechCon;
dynomite: SpeechCon;
eek: SpeechCon;
eep: SpeechCon;
encore: SpeechCon;
en_gard: SpeechCon;
eureka: SpeechCon;
fancy_that: SpeechCon;
geronimo: SpeechCon;
giddy_up: SpeechCon;
good_grief: SpeechCon;
good_luck: SpeechCon;
good_riddance: SpeechCon;
gotcha: SpeechCon;
great_scott: SpeechCon;
heads_up: SpeechCon;
hear_hear: SpeechCon;
hip_hip_hooray: SpeechCon;
hiss: SpeechCon;
honk: SpeechCon;
howdy: SpeechCon;
hurrah: SpeechCon;
hurray: SpeechCon;
huzzah: SpeechCon;
jeepers_creepers: SpeechCon;
jiminy_cricket: SpeechCon;
jinx: SpeechCon;
just_kidding: SpeechCon;
kaboom: SpeechCon;
kablam: SpeechCon;
kaching: SpeechCon;
kapow: SpeechCon;
katchow: SpeechCon;
kazaam: SpeechCon;
kerbam: SpeechCon;
kerboom: SpeechCon;
kerching: SpeechCon;
kerchoo: SpeechCon;
kerflop: SpeechCon;
kerplop: SpeechCon;
kerplunk: SpeechCon;
kerpow: SpeechCon;
kersplat: SpeechCon;
kerthump: SpeechCon;
knock_knock: SpeechCon;
le_sigh: SpeechCon;
look_out: SpeechCon;
mamma_mia: SpeechCon;
man_overboard: SpeechCon;
mazel_tov: SpeechCon;
meow: SpeechCon;
merci: SpeechCon;
moo: SpeechCon;
nanu_nanu: SpeechCon;
neener_neener: SpeechCon;
no_way: SpeechCon;
now_now: SpeechCon;
oh_boy: SpeechCon;
oh_brother: SpeechCon;
oh_dear: SpeechCon;
oh_my: SpeechCon;
oh_snap: SpeechCon;
oink: SpeechCon;
okey_dokey: SpeechCon;
oof: SpeechCon;
ooh_la_la: SpeechCon;
open_sesame: SpeechCon;
ouch: SpeechCon;
oy: SpeechCon;
phew: SpeechCon;
phooey: SpeechCon;
ping: SpeechCon;
plop: SpeechCon;
poof: SpeechCon;
pop: SpeechCon;
pow: SpeechCon;
quack: SpeechCon;
read_em_and_weep: SpeechCon;
ribbit: SpeechCon;
righto: SpeechCon;
roger: SpeechCon;
ruh_roh: SpeechCon;
shucks: SpeechCon;
splash: SpeechCon;
spoiler_alert: SpeechCon;
squee: SpeechCon;
swish: SpeechCon;
swoosh: SpeechCon;
ta_da: SpeechCon;
ta_ta: SpeechCon;
tee_hee: SpeechCon;
there_there: SpeechCon;
thump: SpeechCon;
tick_tick_tick: SpeechCon;
tick_tock: SpeechCon;
touche: SpeechCon;
tsk_tsk: SpeechCon;
tweet: SpeechCon;
uh_huh: SpeechCon;
uh_oh: SpeechCon;
um: SpeechCon;
voila: SpeechCon;
vroom: SpeechCon;
wahoo: SpeechCon;
wah_wah: SpeechCon;
watch_out: SpeechCon;
way_to_go: SpeechCon;
well_done: SpeechCon;
well_well: SpeechCon;
wham: SpeechCon;
whammo: SpeechCon;
whee: SpeechCon;
whew: SpeechCon;
woof: SpeechCon;
whoops_a_daisy: SpeechCon;
whoosh: SpeechCon;
woo_hoo: SpeechCon;
wow: SpeechCon;
wowza: SpeechCon;
wowzer: SpeechCon;
yadda_yadda_yadda: SpeechCon;
yay: SpeechCon;
yikes: SpeechCon;
yippee: SpeechCon;
yoink: SpeechCon;
yoo_hoo: SpeechCon;
you_bet: SpeechCon;
yowza: SpeechCon;
yowzer: SpeechCon;
yuck: SpeechCon;
yum: SpeechCon;
zap: SpeechCon;
zing: SpeechCon;
zoinks: SpeechCon;
};
export type SpeechConUK = "abracadabra" | "ace" | "achoo" | "ahoy" | "all" | "aloha" | "aooga" | "arrivederci" | "as if" | "as you wish" | "au revoir" | "aw" | "aw man" | "awesome" | "baa" | "bah humbug" | "bam" | "bang" | "bazinga" | "beep beep" | "bingo" | "blah" | "blarg" | "blast" | "blimey" | "bob's your uncle" | "boing" | "bon appetit" | "bon voyage" | "bonjour" | "boo" | "boo hoo" | "booya" | "bother" | "bravo" | "caw" | "cha ching" | "checkmate" | "cheer up" | "cheerio" | "cheers" | "chirp" | "choo choo" | "clank" | "clickety clack" | "cock a doodle doo" | "codswallop" | "coo" | "cowabunga" | "crikey" | "d'oh" | "darn" | "ditto" | "dot dot dot" | "duh" | "dun dun dun" | "eek" | "eep" | "en garde" | "encore" | "eureka" | "ew" | "fancy that" | "geronimo" | "giddy up" | "good golly" | "good grief" | "good luck" | "good riddance" | "gosh" | "gotcha" | "great scott" | "ha" | "ha ha" | "heads up" | "hear hear" | "hip hip hooray" | "hiss" | "honk" | "howdy" | "howzat" | "hurrah" | "hurray" | "huzzah" | "jeepers creepers" | "jiminy cricket" | "jinx" | "just kidding" | "kablam" | "kaboom" | "kaching" | "kapow" | "knock knock" | "le sigh" | "look out" | "mamma mia" | "man overboard" | "mazel tov" | "meow" | "merci" | "moo" | "no way" | "nom nom" | "now now" | "oh boy" | "oh dear" | "oh my" | "oh my giddy aunt" | "oh snap" | "okey dokey" | "oof" | "ooh la la" | "open sesame" | "ouch" | "ow" | "oy" | "pardon" | "phew" | "phooey" | "ping" | "plop" | "pop" | "pow" | "quack" | "read 'em and weep" | "ribbit" | "righto" | "roger" | "sigh" | "simples" | "splash" | "spoiler alert" | "squee" | "swish" | "swoosh" | "ta da" | "tallyho" | "tee hee" | "there there" | "thump" | "tick tick tick" | "tick tock" | "tosh" | "touche" | "tsk tsk" | "tut tut" | "tweet" | "uh huh" | "uh oh" | "voila" | "vroom" | "wahoo" | "watch out" | "way to go" | "well done" | "well well" | "wham" | "whammo" | "whee" | "whoop" | "whoops" | "whoops a daisy" | "whoosh" | "woo hoo" | "wow" | "wowza" | "yadda yadda yadda" | "yippee" | "yoink" | "you bet" | "yowza" | "yum" | "zap" | "zing" | "zoinks";
export declare const ConUK: {
abracadabra: SpeechConUK;
ace: SpeechConUK;
achoo: SpeechConUK;
ahoy: SpeechConUK;
all: SpeechConUK;
aloha: SpeechConUK;
aooga: SpeechConUK;
arrivederci: SpeechConUK;
as_if: SpeechConUK;
as_you_wish: SpeechConUK;
au_revoir: SpeechConUK;
aw: SpeechConUK;
aw_man: SpeechConUK;
awesome: SpeechConUK;
baa: SpeechConUK;
bah_humbug: SpeechConUK;
bam: SpeechConUK;
bang: SpeechConUK;
bazinga: SpeechConUK;
beep_beep: SpeechConUK;
bingo: SpeechConUK;
blah: SpeechConUK;
blarg: SpeechConUK;
blast: SpeechConUK;
blimey: SpeechConUK;
bobs_your_uncle: SpeechConUK;
boing: SpeechConUK;
bon_appetit: SpeechConUK;
bon_voyage: SpeechConUK;
bonjour: SpeechConUK;
boo: SpeechConUK;
boo_hoo: SpeechConUK;
booya: SpeechConUK;
bother: SpeechConUK;
bravo: SpeechConUK;
caw: SpeechConUK;
cha_ching: SpeechConUK;
checkmate: SpeechConUK;
cheer_up: SpeechConUK;
cheerio: SpeechConUK;
cheers: SpeechConUK;
chirp: SpeechConUK;
choo_choo: SpeechConUK;
clank: SpeechConUK;
clickety_clack: SpeechConUK;
cock_a_doodle_doo: SpeechConUK;
codswallop: SpeechConUK;
coo: SpeechConUK;
cowabunga: SpeechConUK;
crikey: SpeechConUK;
doh: SpeechConUK;
darn: SpeechConUK;
ditto: SpeechConUK;
dot_dot_dot: SpeechConUK;
duh: SpeechConUK;
dun_dun_dun: SpeechConUK;
eek: SpeechConUK;
eep: SpeechConUK;
en_garde: SpeechConUK;
encore: SpeechConUK;
eureka: SpeechConUK;
ew: SpeechConUK;
fancy_that: SpeechConUK;
geronimo: SpeechConUK;
giddy_up: SpeechConUK;
good_golly: SpeechConUK;
good_grief: SpeechConUK;
good_luck: SpeechConUK;
good_riddance: SpeechConUK;
gosh: SpeechConUK;
gotcha: SpeechConUK;
great_scott: SpeechConUK;
ha: SpeechConUK;
ha_ha: SpeechConUK;
heads_up: SpeechConUK;
hear_hear: SpeechConUK;
hip_hip_hooray: SpeechConUK;
hiss: SpeechConUK;
honk: SpeechConUK;
howdy: SpeechConUK;
howzat: SpeechConUK;
hurrah: SpeechConUK;
hurray: SpeechConUK;
huzzah: SpeechConUK;
jeepers_creepers: SpeechConUK;
jiminy_cricket: SpeechConUK;
jinx: SpeechConUK;
just_kidding: SpeechConUK;
kablam: SpeechConUK;
kaboom: SpeechConUK;
kaching: SpeechConUK;
kapow: SpeechConUK;
knock_knock: SpeechConUK;
le_sigh: SpeechConUK;
look_out: SpeechConUK;
mamma_mia: SpeechConUK;
man_overboard: SpeechConUK;
mazel_tov: SpeechConUK;
meow: SpeechConUK;
merci: SpeechConUK;
moo: SpeechConUK;
no_way: SpeechConUK;
nom_nom: SpeechConUK;
now_now: SpeechConUK;
oh_boy: SpeechConUK;
oh_dear: SpeechConUK;
oh_my: SpeechConUK;
oh_my_giddy_aunt: SpeechConUK;
oh_snap: SpeechConUK;
okey_dokey: SpeechConUK;
oof: SpeechConUK;
ooh_la_la: SpeechConUK;
open_sesame: SpeechConUK;
ouch: SpeechConUK;
ow: SpeechConUK;
oy: SpeechConUK;
pardon: SpeechConUK;
phew: SpeechConUK;
phooey: SpeechConUK;
ping: SpeechConUK;
plop: SpeechConUK;
pop: SpeechConUK;
pow: SpeechConUK;
quack: SpeechConUK;
read_em_and_weep: SpeechConUK;
ribbit: SpeechConUK;
righto: SpeechConUK;
roger: SpeechConUK;
sigh: SpeechConUK;
simples: SpeechConUK;
splash: SpeechConUK;
spoiler_alert: SpeechConUK;
squee: SpeechConUK;
swish: SpeechConUK;
swoosh: SpeechConUK;
ta_da: SpeechConUK;
tallyho: SpeechConUK;
tee_hee: SpeechConUK;
there_there: SpeechConUK;
thump: SpeechConUK;
tick_tick_tick: SpeechConUK;
tick_tock: SpeechConUK;
tosh: SpeechConUK;
touche: SpeechConUK;
tsk_tsk: SpeechConUK;
tut_tut: SpeechConUK;
tweet: SpeechConUK;
uh_huh: SpeechConUK;
uh_oh: SpeechConUK;
voila: SpeechConUK;
vroom: SpeechConUK;
wahoo: SpeechConUK;
watch_out: SpeechConUK;
way_to_go: SpeechConUK;
well_done: SpeechConUK;
well_well: SpeechConUK;
wham: SpeechConUK;
whammo: SpeechConUK;
whee: SpeechConUK;
whoop: SpeechConUK;
whoops: SpeechConUK;
whoops_a_daisy: SpeechConUK;
whoosh: SpeechConUK;
woo_hoo: SpeechConUK;
wow: SpeechConUK;
wowza: SpeechConUK;
yadda_yadda_yadda: SpeechConUK;
yippee: SpeechConUK;
yoink: SpeechConUK;
you_bet: SpeechConUK;
yowza: SpeechConUK;
yum: SpeechConUK;
zap: SpeechConUK;
zing: SpeechConUK;
zoinks: SpeechConUK;
};
export type SpeechConDE = "aber hallo" | "aber sicher" | "abrakadabra" | "ach" | "ach du grüne neune" | "ach du liebe zeit" | "ach du meine güte" | "ach ja" | "ach so" | "achje" | "achtung" | "ade" | "ah" | "aha" | "ähm" | "ahoi" | "alles klar" | "aloha" | "als ob" | "argh" | "arrivederci" | "aso" | "au" | "au weia" | "aua" | "autsch" | "bazinga" | "bingo" | "bis bald" | "bis dann" | "bla" | "boing" | "bon appetit" | "bon voyage" | "bonjour" | "bravo" | "brumm" | "buh" | "buhu" | "bumm" | "bzz" | "da lachen ja die hühner" | "ding dong" | "dito" | "donner und doria" | "donnerwetter" | "ebenso" | "en garde" | "ey" | "geh nur" | "gemach" | "genug" | "gesundheit" | "gott im himmel" | "grüß gott" | "gute reise" | "guten appetit" | "hach ja" | "halleluja" | "hals und beinbruch" | "halt" | "hände hoch" | "heiliger strohsack" | "heisa" | "hey" | "hihi" | "hipp hipp hurra" | "hört hört" | "hü" | "hüa" | "huch" | "huhu" | "hui" | "hurra" | "ich glaub ich bin im kino" | "ich glaub mein schwein pfeift" | "ich glaub mich knutscht ein elch" | "ich glaub mich laust der affe" | "ich glaub mich tritt ein pferd" | "igitt" | "iiieh" | "ist nicht dein ernst" | "japp" | "jawohl" | "jo" | "juhu" | "kein kommentar" | "keine ursache" | "kikeriki" | "klar" | "klick klack" | "kopf hoch" | "kuckuck" | "lass es dir schmecken" | "lecker" | "los" | "mach's gut" | "mahlzeit" | "mamma mia" | "mann über bord" | "manometer" | "mazel tov" | "mein gott" | "merci" | "miau" | "mist" | "moin" | "muh" | "na klar" | "na sieh mal einer an" | "na und?" | "na?" | "naja" | "nanu?" | "ne" | "nee" | "nichts da" | "nix da" | "nö" | "null problemo" | "obacht" | "och" | "oh mann" | "oh mein gott" | "oh my god" | "oh nein" | "oh oh" | "ohne scheiß" | "oink" | "oje" | "okey dokey" | "ooh la la" | "pfui" | "piep" | "plop" | "plumps" | "prima" | "prosit" | "prost" | "puff" | "puh" | "pustekuchen" | "schachmatt" | "schade" | "schau an" | "sesam öffne dich" | "seufz" | "sieh an" | "siehe da" | "siehste?" | "spoileralarm" | "stimmt" | "super" | "supi" | "süßes oder saures" | "tada" | "tatsächlich" | "tick tack" | "tja" | "touche" | "tschö" | "türlich" | "tut" | "uff" | "verdammt" | "verflixt" | "viel glück" | "voila" | "von wegen" | "vorsicht" | "war nur ein scherz" | "was zur hölle" | "weh mir" | "wehe" | "wie du meinst" | "willkommen" | "wow" | "wuff" | "yay" | "zugabe" | "zum wohl";
export declare const ConDE: {
aber_hallo: SpeechConDE;
aber_sicher: SpeechConDE;
abrakadabra: SpeechConDE;
ach: SpeechConDE;
ach_du_grüne_neune: SpeechConDE;
ach_du_liebe_zeit: SpeechConDE;
ach_du_meine_güte: SpeechConDE;
ach_ja: SpeechConDE;
ach_so: SpeechConDE;
achje: SpeechConDE;
achtung: SpeechConDE;
ade: SpeechConDE;
ah: SpeechConDE;
aha: SpeechConDE;
ähm: SpeechConDE;
ahoi: SpeechConDE;
alles_klar: SpeechConDE;
aloha: SpeechConDE;
als_ob: SpeechConDE;
argh: SpeechConDE;
arrivederci: SpeechConDE;
aso: SpeechConDE;
au: SpeechConDE;
au_weia: SpeechConDE;
aua: SpeechConDE;
autsch: SpeechConDE;
bazinga: SpeechConDE;
bingo: SpeechConDE;
bis_bald: SpeechConDE;
bis_dann: SpeechConDE;
bla: SpeechConDE;
boing: SpeechConDE;
bon_appetit: SpeechConDE;
bon_voyage: SpeechConDE;
bonjour: SpeechConDE;
bravo: SpeechConDE;
brumm: SpeechConDE;
buh: SpeechConDE;
buhu: SpeechConDE;
bumm: SpeechConDE;
bzz: SpeechConDE;
da_lachen_ja_die_hühner: SpeechConDE;
ding_dong: SpeechConDE;
dito: SpeechConDE;
donner_und_doria: SpeechConDE;
donnerwetter: SpeechConDE;
ebenso: SpeechConDE;
en_garde: SpeechConDE;
ey: SpeechConDE;
geh_nur: SpeechConDE;
gemach: SpeechConDE;
genug: SpeechConDE;
gesundheit: SpeechConDE;
gott_im_himmel: SpeechConDE;
grüß_gott: SpeechConDE;
gute_reise: SpeechConDE;
guten_appetit: SpeechConDE;
hach_ja: SpeechConDE;
halleluja: SpeechConDE;
hals_und_beinbruch: SpeechConDE;
halt: SpeechConDE;
hände_hoch: SpeechConDE;
heiliger_strohsack: SpeechConDE;
heisa: SpeechConDE;
hey: SpeechConDE;
hihi: SpeechConDE;
hipp_hipp_hurra: SpeechConDE;
hört_hört: SpeechConDE;
hü: SpeechConDE;
hüa: SpeechConDE;
huch: SpeechConDE;
huhu: SpeechConDE;
hui: SpeechConDE;
hurra: SpeechConDE;
ich_glaub_ich_bin_im_kino: SpeechConDE;
ich_glaub_mein_schwein_pfeift: SpeechConDE;
ich_glaub_mich_knutscht_ein_elch: SpeechConDE;
ich_glaub_mich_laust_der_affe: SpeechConDE;
ich_glaub_mich_tritt_ein_pferd: SpeechConDE;
igitt: SpeechConDE;
iiieh: SpeechConDE;
ist_nicht_dein_ernst: SpeechConDE;
japp: SpeechConDE;
jawohl: SpeechConDE;
jo: SpeechConDE;
juhu: SpeechConDE;
kein_kommentar: SpeechConDE;
keine_ursache: SpeechConDE;
kikeriki: SpeechConDE;
klar: SpeechConDE;
klick_klack: SpeechConDE;
kopf_hoch: SpeechConDE;
kuckuck: SpeechConDE;
lass_es_dir_schmecken: SpeechConDE;
lecker: SpeechConDE;
los: SpeechConDE;
mach: SpeechConDE;
mahlzeit: SpeechConDE;
mamma_mia: SpeechConDE;
mann_über_bord: SpeechConDE;
manometer: SpeechConDE;
mazel_tov: SpeechConDE;
mein_gott: SpeechConDE;
merci: SpeechConDE;
miau: SpeechConDE;
mist: SpeechConDE;
moin: SpeechConDE;
muh: SpeechConDE;
na_klar: SpeechConDE;
na_sieh_mal_einer_an: SpeechConDE;
na_und_: SpeechConDE;
na_: SpeechConDE;
naja: SpeechConDE;
nanu: SpeechConDE;
ne: SpeechConDE;
nee: SpeechConDE;
nichts_da: SpeechConDE;
nix_da: SpeechConDE;
nö: SpeechConDE;
null_problemo: SpeechConDE;
obacht: SpeechConDE;
och: SpeechConDE;
oh_mann: SpeechConDE;
oh_mein_gott: SpeechConDE;
oh_my_god: SpeechConDE;
oh_nein: SpeechConDE;
oh_oh: SpeechConDE;
ohne_scheiß: SpeechConDE;
oink: SpeechConDE;
oje: SpeechConDE;
okey_dokey: SpeechConDE;
ooh_la_la: SpeechConDE;
pfui: SpeechConDE;
piep: SpeechConDE;
plop: SpeechConDE;
plumps: SpeechConDE;
prima: SpeechConDE;
prosit: SpeechConDE;
prost: SpeechConDE;
puff: SpeechConDE;
puh: SpeechConDE;
pustekuchen: SpeechConDE;
schachmatt: SpeechConDE;
schade: SpeechConDE;
schau_an: SpeechConDE;
sesam_öffne_dich: SpeechConDE;
seufz: SpeechConDE;
sieh_an: SpeechConDE;
siehe_da: SpeechConDE;
siehste: SpeechConDE;
spoileralarm: SpeechConDE;
stimmt: SpeechConDE;
super: SpeechConDE;
supi: SpeechConDE;
süßes_oder_saures: SpeechConDE;
tada: SpeechConDE;
tatsächlich: SpeechConDE;
tick_tack: SpeechConDE;
tja: SpeechConDE;
touche: SpeechConDE;
tschö: SpeechConDE;
türlich: SpeechConDE;
tut: SpeechConDE;
uff: SpeechConDE;
verdammt: SpeechConDE;
verflixt: SpeechConDE;
viel_glück: SpeechConDE;
voila: SpeechConDE;
von_wegen: SpeechConDE;
vorsicht: SpeechConDE;
war_nur_ein_scherz: SpeechConDE;
was_zur_hölle: SpeechConDE;
weh_mir: SpeechConDE;
wehe: SpeechConDE;
wie_du_meinst: SpeechConDE;
willkommen: SpeechConDE;
wow: SpeechConDE;
wuff: SpeechConDE;
yay: SpeechConDE;
zugabe: SpeechConDE;
zum_wohl: SpeechConDE;
};
export type Effect = "whispered";
export declare const Effect: {
whispered: "whispered";
};
export type BreakStrengthType = "none" | "x-weak" | "weak" | "medium" | "strong" | "x-strong";
/**
* amazon:VB: Interpret the word as a verb (present simple).
*
* amazon:VBD: Interpret the word as a past participle.
*
* amazon:NN: Interpret the word as a noun.
*
* amazon:SENSE_1: Use the non-default sense of the word. For example,
* the noun “bass” is pronounced differently depending on meaning.
* The “default” meaning is the lowest part of the musical range. The
* alternate sense (which is still a noun) is a freshwater fish.
* Specifying <speak><w role="amazon:SENSE_1">bass</w>"</speak>
* renders the non-default pronunciation (freshwater fish).
*/
export type PartOfSpeech = "amazon:VB" | "amazon:VBD" | "amazon:NN" | "amazon:SENSE_1";
export declare const PartOfSpeech: {
/**
* Interpret the word as a verb (present simple).
*/
verb: PartOfSpeech;
/**
* Interpret the word as a past participle.
*/
past_participle: PartOfSpeech;
/**
* Interpret the word as a noun.
*/
noun: PartOfSpeech;
/**
* Use the non-default sense of the word. For example,
* the noun “bass” is pronounced differently depending on meaning.
* The “default” meaning is the lowest part of the musical range.
* The alternate sense (which is still a noun) is a freshwater
* fish. Specifying
* <speak><w role="amazon:SENSE_1">bass</w>"</speak>
* renders the non-default pronunciation (freshwater fish).
*/
sense1: PartOfSpeech;
};
export declare class Ssml {
private static lc;
/**
* Wraps a given list of paragraph strings in `<speak>` tags, with
* optional paragraph `<p>` tags.
*
* @param paras individual paragraphs to be wrapped in <p></p> tags.
* @param addParaTags If true, wraps individual strings in paras with `<p>` tags. Otherwise just concats.
*/
static wrapSsmlSpeak(paras: string[], addParaTags?: boolean): string;
/**
* This simply replaces <speak> and </speak> tags with an empty
* string.
*
* Use this when you want to add some text to existing ssml and
* then re-wrap the ssml.
*
* @see {Helper.stripSsml} function.
*
* @param ssml with <speak> tag around the whole thing.
*/
static unwrapSsmlSpeak(ssml: string): string;
/**
* Simply wraps with <p> tag.
*
* Represents a paragraph. This tag provides extra-strong breaks
* before and after the tag. This is equivalent to specifying a
* pause with <break strength="x-strong"/>.
*
* @param text to wrap
*/
static p(text: string): string;
/**
* Simply wraps with <s> tag.
*
* Represents a sentence. This tag provides strong breaks before
* and after the tag.
*
* This is equivalent to:
* Ending a sentence with a period (.).
* Specifying a pause with <break strength="strong"/>.
* @param text to wrap
*/
static s(text: string): string;
/**
* Strips all tags within ssml to produce plain text.
*
* @see {Helper.unwrapSsmlSpeak} function.
*
* @param ssml to strip
*/
static stripSsml(ssml: string): string;
/**
* Wraps a given text in an ssml phoneme tag with the given
* pronunciation and alphabet.
*
* @param text Literal text that we're wrapping the phoneme tag around, e.g. "sewing".
* @param pronunciation the phoneme itself, e.g. "soʊɪŋ"
* @param alphabet phoneme alphabet, either "ipa" or "x-sampe" (ATOW)
*
* @see {@link https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#prosody|SsmlReference}
*/
static phoneme(text: string, pronunciation: string, alphabet?: "ipa" | "x-sampa"): string;
/**
* Wraps a given text in an ssml emphasis tag.
*
* e.g. <emphasis level="${level}">${text}</emphasis>`
*
* @param text to wrap with the emphasis tag
* @param level attribute in emphasis tag. Valid values "strong" | "moderate" | "reduced" = "moderate"
*
* @see {@link https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#prosody|SsmlReference}
*/
static emphasis(text: string, level?: "strong" | "moderate" | "reduced"): string;
/**
* Wraps a given text in an ssml prosody tag with the given
* options of rate, pitch, and/or volume.
*
* @param rate valid values ATOW "x-slow" | "slow" | "medium" | "fast" | "x-fast" | number,
* @param pitch valid values ATOW "x-low" | "low" | "medium" | "high" | "x-high" | number,
* @param volume valid values ATOW "silent" | "x-soft" | "soft" | "medium" | "loud" | "x-loud" | number
*
* @see {@link https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#prosody|SsmlReference}
*/
static prosody(text: string, { rate, pitch, volume }: {
rate?: ProsodyRateType;
pitch?: ProsodyPitchType;
volume?: ProsodyVolumeType;
}): string;
/**
* Generates SpeechCon SSML.
* https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speechcon-reference
*/
static speech(speechCon: SpeechCon): string;
/**
* Applies Amazon-specific effects to the speech.
*
* https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#amazon-effect
*
* The name of the effect to apply to the speech. Available effects:
* whispered: Applies a whispering effect to the speech.
* @param effect Which amazon:effect. ATOW only whispered implemented.
* @param s text to wrap in the effect.
*/
static amazon(effect: Effect, s: string): string;
/**
* The audio tag lets you provide the URL for an MP3 file that the
* Alexa service can play while rendering a response. You can use
* this to embed short, pre-recorded audio within your service’s
* response. For example, you could include sound effects alongside
* your text-to-speech responses, or provide responses using a
* voice associated with your brand. For more information, see
* Including Short Pre-Recorded Audio in your Response at
* https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/handling-requests-sent-by-alexa#audio.
*
* Note the following requirements and limitations:
*
* * The MP3 must be hosted at an Internet-accessible HTTPS
* endpoint. HTTPS is required, and the domain hosting the MP3
* file must present a valid, trusted SSL certificate.
* Self-signed certificates cannot be used.
* * The MP3 must not contain any customer-specific or other
* sensitive information.
* * The MP3 must be a valid MP3 file (MPEG version 2).
* * The audio file cannot be longer than ninety (90) seconds.
* * The bit rate must be 48 kbps. Note that this bit rate gives a
* good result when used with spoken content, but is generally
* not a high enough quality for music.
* * The sample rate must be 16000 Hz.
*
* You may need to use converter software to convert your MP3 files
* to the required codec version (MPEG version 2) and bit rate (48
* kbps).
*
* https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#audio
*
* @param srcUrl Specifies the URL for the MP3 file.
*/
static audio(srcUrl: string): string;
/**
* Represents a pause in the speech. Set the length of the pause
* with the strength or time attributes.
*
* https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#break
*
* @param param0
*/
static break({ strength, s, ms }: {
/**
* none: No pause should be outputted. This can be used to remove a pause that would normally occur (such as after a period).
*
* x-weak: No pause should be outputted (same as none).
*
* weak: Treat adjacent words as if separated by a single comma (equivalent to medium).
*
* medium: Treat adjacent words as if separated by a single comma.
*
* strong: Make a sentence break (equivalent to using the <s> tag).
*
* x-strong: Make a paragraph break (equivalent to using the <p> tag).
*/
strength?: BreakStrengthType;
/**
* Duration of the pause in seconds; up to 10 seconds.
*/
s?: number;
/**
* Duration of the pause in milliseconds; up to 10000 milliseconds.
*/
ms?: number;
}): string;
/**
* Takes a given text that will be written and provides an alias
* for it when it's actually spoken.
*
* For example, if the written text is the element symbol "Mg", then
* you probably want to verbally say the entire word: "Magnesium".
* In this case, the "text" is "Mg" and the "alias" is "Magnesium".
*
* @see (@link https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#sub)
*
* @param text Written text that will be substituted when spoken, e.g. "Mg"
* @param alias Spoken alias that will be spoken, e.g. "Magnesium"
*/
static sub(text: string, alias: string): string;
/**
* Similar to <say-as>, this tag customizes the pronunciation of
* words by specifying the word’s part of speech.
*
* @param text Text that requires clarity.
* @param partOfSpeech Context provided for the given text.
*/
static w(text: string, partOfSpeech: PartOfSpeech): string;
/**
* Describes how the text should be interpreted. This lets you
* provide additional context to the text and eliminate any
* ambiguity on how Alexa should render the text. Indicate how
* Alexa should interpret the text with the interpret-as attribute.
*
* Note that the Alexa service attempts to interpret the provided
* text correctly based on the text’s formatting even without this
* tag. For example, if your output speech includes “202-555-1212”,
* Alexa speaks each individual digit, with a brief pause for each
* dash. You don’t need to use <say-as interpret-as="telephone"> in
* this case. However, if you provided the text “2025551212”, but
* you wanted Alexa to speak it as a phone number, you would need
* to use <say-as interpret-as="telephone">.
*
* @example
* <speak>
* Here is a number spoken as a cardinal number:
* <say-as interpret-as="cardinal">12345</say-as>.
* Here is the same number with each digit spoken separately:
* <say-as interpret-as="digits">12345</say-as>.
* Here is a word spelled out: <say-as interpret-as="spell-out">hello</say-as>
* </speak>
*
* @see
* https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference#say-as
*/
static sayAs({ text, interpret, format }: {
/**
* Text to specify interpretation.
*/
text: string;
/**
* Value that indicates how text should be interpreted.
*
* @see {InterpretAs}
*/
interpret: InterpretAs;
/**
* Only used when interpret-as is set to date. Set to one of
* the following to indicate format of the date:
*
* mdy
* dmy
* ymd
* md
* dm
* ym
* my
* d
* m
* y
*
* Alternatively, if you provide the date in YYYYMMDD format,
* the format attribute is ignored. You can include question
* marks (?) for portions of the date to leave out. For
* instance, Alexa would speak <say-as interpret-as="date">????
* 0922</say-as> as “September 22nd”.
*/
format?: SayAsDate;
}): string;
}
//# sourceMappingURL=ssml-helper.d.mts.map