Global

Members

(constant) DEFAULT_CAT_PRIORITY

Description:

• The default category priority when a folder's sidecar sets none (lower = higher in the picker).

Source:

• engine/blockCatalog.js, line 30

(constant) DEFAULT_INTENSITY

Description:

• Build the {#name} block stage bound to a loader (loader-injected port; suffix-resolved, auto-fx/artists, danbooru substitution).

Source:

• engine/core/stages/block.js, line 29

(constant) DPL_INSERT_CATALOG

Description:

• The categories and their constructs. Language-neutral: ids, DPL syntax, snippet templates, examples.

Source:

• engine/dplInsertCatalog.js, line 39

(constant) MAX_GROUP_DEPTH

Description:

• Recursion cutoff for group-includes-group nesting.

Source:

• engine/listResolve.js, line 15

(constant) NSFW_TOKEN :RegExp

Description:

• Matches an nsfw token: a standalone word in a list name, delimited by a path separator, dash, dot, underscore, or the start/end of the string. So d/general-nsfw, clothes-nsfw, foo.nsfw.bar all match, but nsfwish does not.

Source:

• engine/gatedLists.js, line 32

Type:

• RegExp

(constant) RESERVED_ANY :string

Description:

• Reserved wildcard base: {#any} (and {#any-sfw} / {#any-nsfw}) is not a file — it runs one random generator drawn from the whole v2 catalog, mode-aware. Reserved like the lists' {keyword}.

Source:

• engine/blockManifest.js, line 22

Type:

• string

(constant) RESERVED_WILDCARD :string

Description:

• Reserved wildcard base. {keyword} (and {keyword-sfw} / {keyword-nsfw}) are not files — they resolve to a random word drawn from ALL loaded vocabulary (mode-aware). The name is reserved: it always supersedes any list literally named keyword, silently (no error), the same way nsfw is a reserved filename token.

Source:

• engine/nameOrder.js, line 19

Type:

• string

(constant) RNG

Description:

• The DPL random seam — every method draws from the ambient source via randomFloat.

Source:

• engine/core/dpl/rng.js, line 11

(constant) SFW_SUFFIX

Description:

• Suffix tokens that select an exclusive SFW or NSFW-inclusive variant.

Source:

• engine/nameOrder.js, line 9

(constant) blockTags :Object.<string, {category: (string|undefined), anime: (boolean|undefined), nsfw: (boolean|undefined)}>

Description:

• Per-generator tag metadata (the analog of listTags): a category plus anime/nsfw flags, for UI badges and docs. The category is normally derivable from the folder; this map only needs entries that carry extra flags. Anything absent defaults to { anime:false, nsfw:false }.

Source:

• engine/blockManifest.js, line 39

Type:

• Object.<string, {category: (string|undefined), anime: (boolean|undefined), nsfw: (boolean|undefined)}>

(constant) browserLoader :object

Description:

• Browser data loader for the engine. Names/structure are served synchronously from the bundle's glob keys; contents (list lines, generators, descriptions, presets) come from the code-split chunk loaded by initBrowserCatalog and read as empty/null until it resolves.

Source:

• engine/core/browserLoader.js, line 265

Type:

• object

(constant) engineDefaults

Source:

• engine/nodeEngine.js, line 55

(constant) listTags :Object.<string, {category: (string|undefined), anime: (boolean|undefined), nsfw: (boolean|undefined)}>

Description:

• Per-list metadata. Any list not listed here defaults to { anime:false, nsfw:false }. nsfw:true means the list as a whole leans adult (still drawn only when includeAdult is on if it is also gated).

Source:

• engine/listTags.js, line 13

Type:

• Object.<string, {category: (string|undefined), anime: (boolean|undefined), nsfw: (boolean|undefined)}>

(constant) metroLoader :object

Description:

• Metro data loader for the engine — the synchronous, static-catalog analog of nodeLoader/browserLoader. Implements readListLines, listNames, loadBlock, blockNames, and the group/marker/meta/preset accessors.

Source:

• engine/core/metroLoader.js, line 130

Type:

• object

(constant) nodeLoader :object

Description:

• Node data loader for the engine: filesystem reads + createRequire block loading. Implements readListLines, listNames, loadBlock, blockNames. Reads the app's built-in data/ content AND the user overlay under user/ (user wins on a name clash).

Source:

• engine/core/nodeLoader.js, line 230

Type:

• object

Methods

adultAllowed() → {boolean}

Source:

• engine/promptFilesAndSuggestions.js, line 184

Returns:

Type

boolean

allListNames(names) → {Array.<string>}

Source:

• engine/nameOrder.js, line 95

Parameters:

Returns:

Type

Array.<string>

applyIntensityMod()

Description:

• Apply a relative modifier to an intensity, clamped to 1..100. A signed percent is taken of the value — +25 → ×1.25, -25 → ×0.75 ("25% more/less of the intensity"). null/"" → unchanged.

Source:

• engine/core/dpl/intensity.js, line 47

applyPreset(base, preset) → {object}

Description:

• Apply a preset's legacy-shaped object onto flat settings. preset.settings merges flat; the legacy imageSettings / upscaleSettings sub-objects are mapped onto the flat keys the providers read (width→imageWidth, height→imageHeight, steps→imageSteps, …). Later presets/flags override.

Source:

• engine/presets.js, line 87

Parameters:

Returns:

Type

object

artistRepeater(artist, alias, settings) → {string}

Description:

• Emit a random number of artist tokens — gated by settings.includeArtist and a 50% coin flip — between settings.minArtist and settings.maxArtist.

Source:

• engine/helpers/keywordRepeater.js, line 71

Parameters:

Returns:

Type

string

autoGroupListDirs(listNames, enableDirsopt, disableDirsopt) → {Array.<string>}

Description:

• Folders that are IMPLIED groups: a folder with 2+ direct list files is auto-marked (referenceable as {folder} = union of its own lists). An enable-group-list marker forces a folder on (even with one list); a disable-group-list marker forces it off. Does NOT stack — only the folder's own direct lists count, not its subfolders.

Source:

• engine/listResolve.js, line 69

Parameters:

Returns:

Type

Array.<string>

blockNames() → {Array.<string>}

Source:

• engine/nodeEngine.js, line 58

Returns:

Type

Array.<string>

blockTokens() → {Array.<string>}

Description:

• The block generator names to suggest/complete, honouring adult gating via the suggestion builder's classification (user-submitted + excluded generators are kept out of the random pool but still shown here for reference).

Source:

• engine/nodeEngine.js, line 75

Returns:

Type

Array.<string>

bootNodeEngine() → {Object}

Description:

• Boot the engine + suggestion catalog once (idempotent). The suggestion builder reads the live settings (for NSFW gating) via setActiveSettings.

Source:

• engine/nodeEngine.js, line 39

Returns:

Type

Object

buildBlocks(loader, optsopt) → {Array.<object>}

Description:

• Build the categorized building-block groups (Blocks = the generators, Lists = the word lists).

  Within Blocks, the category/folder pills are ordered by each category's sidecar priority (ascending; default 1000), with the virtual any (0) leading and special (9000) trailing.

Source:

• engine/blockCatalog.js, line 88

Parameters:

Returns:

Type

Array.<object>

buildDplCompletions(loader, optsopt) → {Array.<{token: string, label: string, kind: ("gen"|"list"), description: (string|undefined), group: string, category: string}>}

Description:

• Flatten the building-block catalog into autocomplete entries for the DPL editor.

Source:

• engine/blockCatalog.js, line 232

Parameters:

Returns:

Type

Array.<{token: string, label: string, kind: ("gen"|"list"), description: (string|undefined), group: string, category: string}>

buildInsertMenu(labellers) → {Array.<object>}

Description:

• Attach a target's label layer to the shared grammar, producing the menu the UI renders.

Source:

• engine/dplInsertCatalog.js, line 216

Parameters:

Returns:

Type

Array.<object>

buildTree(lines, depth, startopt) → {Object}

Description:

• Recursively group depth-tagged lines into { line, children } nodes.

Source:

• engine/core/dpl/parser.js, line 159

Parameters:

Returns:

Type

Object

camelId(id) → {string}

Description:

• one-of-nothing → oneOfNothing. The label key a target uses for an entry is derived from its id, so a new construct can't be added to the grammar without a label existing for it (the coverage test in tests/unit/dplInsertCatalog.test.js fails). One id, one name, in every target.

Source:

• engine/dplInsertCatalog.js, line 190

Parameters:

Returns:

Type

string

charRank(ch) → {number}

Description:

• Class rank for a single character: symbols (0) sort before digits (1) before letters (2). Gives a guaranteed, predictable ordering.

Source:

• engine/nameOrder.js, line 35

Parameters:

Returns:

Type

number

clampDial()

Description:

• Clamp a percent capture to an integer 1..100 (absent/NaN → default, 0 → 1, >100 → 100).

Source:

• engine/core/stages/block.js, line 33

clampFocus()

Description:

• Normalize a focus argument to an integer 1..100 (undefined → default, 0 → 1, >100 → 100).

Source:

• engine/core/dpl/intensity.js, line 30

clampIntensity()

Description:

• Normalize an intensity argument to an integer 1..100 (undefined → default, 0 → 1, >100 → 100).

Source:

• engine/core/dpl/intensity.js, line 21

classifyRemoval(line, optsopt) → {Object|null}

Description:

• Classify a single list line for removal.

Source:

• engine/contentSafety.js, line 114

Parameters:

Returns:

Type

Object | null

compareNames(a, b) → {number}

Description:

• Natural-order comparator giving a GUARANTEED load/precedence order: symbols first, then numbers in true numeric order (so 2 before 10), then letters alphabetically. Lets users engineer a deterministic default by prefixing a name with a symbol or number.

Source:

• engine/nameOrder.js, line 63

Parameters:

Returns:

Type

number

compileDpl(source, bridgeopt) → {Object}

Description:

• Compile a .dpl source into a block module object (same shape as a JS generator).

Source:

• engine/core/dpl/dpl.js, line 39

Parameters:

Returns:

Type

Object

computeButtonNames(names, forcedDirsopt) → {Object.<string, string>}

Description:

• Compute the SHORTEST unambiguous display token for each list, for editor buttons. By default a list shows just its filename; a name only grows a folder prefix when it would otherwise be ambiguous.

  Two stages:

  1. Manual prefix (.force-prefix) — any name under a folder marked with a .force-prefix file shows its path from the highest such ancestor down (e.g. danbooru/d/general → d/general). These are excluded from the auto step, so they never push a prefix onto anyone else.
  2. Auto prefix — the rest start at the bare filename; whenever two share a token they each step out one more folder until distinct.

  A final pass guarantees every token resolveName()s back to its own canonical name (lengthening if a forced/other name would otherwise shadow it).

Source:

• engine/nameOrder.js, line 236

Parameters:

Returns:

Type

Object.<string, string>

condPasses()

Description:

• Evaluate a dial condition ({op, value}) against the current dial value (intensity or focus).

Source:

• engine/core/dpl/intensity.js, line 55

configure(_loader) → {void}

Description:

• Inject the data loader (fs in Node, glob in the browser). Call once before loadAll().

Source:

• engine/promptFilesAndSuggestions.js, line 27

Parameters:

Returns:

Type

void

consumeBracket()

Description:

• Consume a leading [weight|cond…] bracket from t, recording onto out; no-op if not a spec.

Source:

• engine/core/dpl/parser.js, line 46

convert()

Description:

• Replace every clean emphasis group via re (one capture: open run, inner, close run).

Source:

• engine/core/stages/emphasis.js, line 78

createEngine(loader) → {Object}

Description:

• Create a framework-agnostic prompt engine that runs the same pipeline as the CLI.

Source:

• engine/core/engine.js, line 44

Parameters:

Returns:

Type

Object

createPromptRun(engine, optsopt)

Description:

• Build the shared prompt-run surface over an already-booted engine. Every target that generates prompts uses this instead of re-implementing the seed/reroll rules.

Source:

• engine/promptRun.js, line 67

Parameters:

Returns:

createRng(seedopt) → {Rng}

Description:

• Create an Rng. With no seed (or an empty one) a fresh random seed is generated and recorded on the returned instance's .seed, so a caller can capture it to reproduce the run later.

Source:

• engine/core/rng.js, line 174

Parameters:

Returns:

Type

Rng

cyrb128(str)

Description:

• cyrb128 — hash a string into four 32-bit unsigned integers of seed state. Public-domain algorithm (bryc). Distinct strings give well-separated state, so "1" and "2" are unrelated streams.

Source:

• engine/core/rng.js, line 30

Parameters:

Returns:

danbooruReplacer()

Description:

• Substitute , Person with the danbooru person token when a danbooru keyword file is active.

Source:

• engine/core/stages/block.js, line 65

dedupeLines(lines) → {Object}

Description:

• Drop duplicate entries (case-insensitive, trimmed; keeps the first occurrence and original order).

Source:

• engine/listEditorOps.js, line 59

Parameters:

Returns:

Type

Object

depthToIntensity()

Description:

• Bracket depth (≥1) → intensity percent. De-emphasis floors at 1 (never 0); emphasis caps at 100.

Source:

• engine/core/stages/emphasis.js, line 33

dialExcluded() → {boolean}

Description:

• Hard dial conditions ([i<10%], [f<40%]): deterministic include/exclude, evaluated BEFORE any probability roll. Both an intensity and a focus condition may apply; both must pass to keep the line.

Source:

• engine/core/dpl/renderer.js, line 44

Returns:

Type

boolean

dpJsModule(key) → {object|null}

Description:

• The loaded .js generator module for a key (or null). Exposed so the runtime loader (gui/src/lib/runtimeLoader.js) can execute .js-module generators and resolve .dpl JS sidecars — the one thing that can't be loaded from disk text at runtime (it would need eval). Returns null until initBrowserCatalog has resolved.

Source:

• engine/core/browserLoader.js, line 341

Parameters:

Returns:

Type

object | null

dynGroupDirs(names, enableDirsopt, disableDirsopt) → {Array.<string>}

Description:

• The category folders that are IMPLIED groups: a v2 folder with 2+ generators. Reuses the list rule (autoGroupListDirs) over the v2 names only (v1/ is excluded — it is reached via {#name-v1}, never grouped). Marker dirs force a folder on/off.

Source:

• engine/blockManifest.js, line 52

Parameters:

Returns:

Type

Array.<string>

dynGroupMembers(dir, names) → {Array.<string>}

Description:

• Direct-child generator names of a group folder (NOT descendants — groups don't stack).

Source:

• engine/blockManifest.js, line 66

Parameters:

Returns:

Type

Array.<string>

editIn(settings, keyword) → {string}

Description:

• Prompt-editing "edit-in": [kw:n] — kw appears after step n.

Source:

• engine/helpers/randomEditing.js, line 30

Parameters:

Returns:

Type

string

editOut(settings, keyword) → {string}

Description:

• Prompt-editing "edit-out": [kw::n] — kw drops at step n.

Source:

• engine/helpers/randomEditing.js, line 50

Parameters:

Returns:

Type

string

effectiveGate() → {Object}

Description:

• The node's effective gate. An explicit gate (NN%/maybe/NN% chance/otherwise) always wins; a bare simple-clause bullet (plain text / token / ref) defaults to 50%. Structural bullets (one of / repeat / block) and plain (non-bullet) lines are unconditional. A probability gate is auto-scaled by the current intensity (scaleGate); the bare-otherwise gate of 1 is not.

Source:

• engine/core/dpl/renderer.js, line 58

Returns:

Type

Object

expandPrompt(prompt, settings) → {string}

Description:

• Expand a prompt for a PREVIEW / illustrative example — always re-rolls a fresh example, independent of the user's pinned seed (never reads or advances promptSeed). The caller's settings object is never mutated.

Source:

• engine/promptRun.js, line 108

Parameters:

Returns:

Type

string

expandPromptSeeded(prompt, settings) → {string}

Description:

• Expand a prompt HONOURING the current seed settings (so a pinned roll reproduces it). Used for the real negative-prompt roll (part of the generated image), not for previews.

Source:

• engine/promptRun.js, line 120

Parameters:

Returns:

Type

string

focusWord()

Description:

• The natural-language word for a focus percent 1..100 (the $focus-word token); loose → topic-only.

Source:

• engine/core/dpl/words.js, line 227

forEngine(settings, explicitSeedopt) → {object}

Description:

• Translate app settings into the shape the core engine wants: the image-provider seed is dropped (it's a different field), and the engine seed is resolved via seedFor.

Source:

• engine/promptRun.js, line 46

Parameters:

Returns:

Type

object

forcedToken(segs, forced) → {string|null}

Description:

• The display token from the highest (closest-to-root) forced ancestor folder of segs down, or null when no ancestor folder is forced.

Source:

• engine/nameOrder.js, line 182

Parameters:

Returns:

Type

string | null

gateDecision() → {Object}

Description:

• Decide whether a node runs, given the running prevGateFailed. Rolls a probability gate through the seeded rng. gateBearing (an authored gate, not the default) is what an otherwise pairs against — a non-bearing node never leaves a "failed gate" behind.

Source:

• engine/core/dpl/renderer.js, line 77

Returns:

Type

Object

gatePool(names, isGated) → {Array.<string>}

Description:

• Drop gated (adult) names from a pool unless includeAdult is on.

Source:

• engine/promptFilesAndSuggestions.js, line 195

Parameters:

Returns:

Type

Array.<string>

generatePrompt(settings, explicitSeedopt) → {string}

Description:

• Generate one prompt.

Source:

• engine/promptRun.js, line 79

Parameters:

Returns:

Type

string

generatePrompts(settings) → {Object}

Description:

• Generate settings.promptCount prompts (minimum 1) as a reproducible batch. A base seed is always resolved — the explicit/pinned one, or a freshly minted random one — and the engine forks it per prompt (generateMany), so re-running with that base reproduces the whole batch verbatim (still fully random across runs when no seed is pinned).

Source:

• engine/promptRun.js, line 92

Parameters:

Returns:

Type

Object

getAmbientRng()

Source:

• engine/helpers/random.js, line 59

Returns:

getRndSalt() → {string}

Source:

• engine/core/stages/prompt-salt.js, line 27

Returns:

Type

string

growUntilDistinct(auto, shown, tok)

Description:

• Grow each auto name's shown-folder depth (in shown) by one per round until no two names share a token — the collision-resolution fixpoint.

Source:

• engine/nameOrder.js, line 196

Parameters:

hasNsfwToken(name) → {boolean}

Source:

• engine/gatedLists.js, line 38

Parameters:

Returns:

Type

boolean

hasVariantSuffix(name) → {boolean}

Source:

• engine/nameOrder.js, line 103

Parameters:

Returns:

Type

boolean

impliedGroupMembers(dir, readers) → {Array.<string>}

Description:

• Member reference lines for an IMPLIED group (a .force-group-list folder): the folder's OWN direct list files only (NOT descendants — implied groups don't stack), de-duplicated to base names (so -sfw/-nsfw pairs become one member resolved mode-aware), excluding real groups. The result feeds the normal group-union path.

Source:

• engine/listResolve.js, line 43

Parameters:

Returns:

Type

Array.<string>

init(_settings) → {void}

Description:

• Provide the settings accessor used during suggestion cleanup.

Source:

• engine/promptFilesAndSuggestions.js, line 53

Parameters:

Returns:

Type

void

initBrowserCatalog() → {Promise.<void>}

Description:

• Load the heavy prompt-corpus content (words, generators, .dpl text, sidecars, presets) from the code-split chunk. Idempotent. Names/structure are already available (from glob keys); this only fills the content maps. Until it resolves, content getters return empty/null.

Source:

• engine/core/browserLoader.js, line 228

Returns:

Type

Promise.<void>

intensityWord()

Description:

• The natural-language word for an intensity percent 1..100 (the $intensity-word token).

Source:

• engine/core/dpl/words.js, line 115

isArtistName(loader) → {Object}

Description:

• Create a loader-backed list store with the original once-only depletion + alias behaviour.

Source:

• engine/core/listStore.js, line 19

Parameters:

Returns:

Type

Object

isDigit(ch)

Source:

• engine/nameOrder.js, line 43

Parameters:

isGatedBlock(name) → {boolean}

Description:

• Gate a block behind includeAdult AUTOMATICALLY by its name token — the same rule lists/expansions use (isGatedList) — so a generator named e.g. subject/nude-nsfw is hidden/empty when adult is off, with no hardcoded list to keep in sync. The legacy gatedBlocks array is still honored as an extra escape hatch.

Source:

• engine/gatedLists.js, line 63

Parameters:

Returns:

Type

boolean

isGatedList(name) → {boolean}

Source:

• engine/gatedLists.js, line 51

Parameters:

Returns:

Type

boolean

isNsfw(line) → {boolean}

Source:

• engine/contentSafety.js, line 144

Parameters:

Returns:

Type

boolean

isReservedAny(name) → {boolean}

Source:

• engine/blockManifest.js, line 28

Parameters:

Returns:

Type

boolean

isReservedWildcard(name) → {boolean}

Source:

• engine/nameOrder.js, line 25

Parameters:

Returns:

Type

boolean

joinPieces(pieces) → {string}

Description:

• Weighted-sort a list of { weight, text } pieces (stable; ties keep document order) and join the non-empty ones with ", ".

Source:

• engine/core/dpl/renderer.js, line 23

Parameters:

Returns:

Type

string

keywordRepeater(keyword, alias, settings) → {string}

Description:

• Emit a random number of keyword tokens, between settings.keywordCount and settings.keywordMaxCount.

Source:

• engine/helpers/keywordRepeater.js, line 58

Parameters:

Returns:

Type

string

lexLines(body) → {Array.<{depth: number, text: string, raw: string}>}

Description:

• Turn the body into indentation-tagged raw lines. The indent unit is the first indented line's leading whitespace (tab or N spaces), per the spec; depth = indent / unit.

Source:

• engine/core/dpl/parser.js, line 92

Parameters:

Returns:

Type

Array.<{depth: number, text: string, raw: string}>

listNames() → {Array.<string>}

Source:

• engine/nodeEngine.js, line 64

Returns:

Type

Array.<string>

loadAll() → {void}

Description:

• Load the block and list catalogs.

Source:

• engine/promptFilesAndSuggestions.js, line 170

Returns:

Type

void

loadBlockList() → {object}

Description:

• Classify every block into full / partial (plus the user-submitted bucket) — the lists used by promptSuggestion() and the web file pickers.

Source:

• engine/promptFilesAndSuggestions.js, line 72

Returns:

Type

object

loadListFileList() → {Array.<string>}

Description:

• Load the list names (and cache the artist-excluded subset).

Source:

• engine/promptFilesAndSuggestions.js, line 130

Returns:

Type

Array.<string>

loadPreset(name) → {object|null}

Description:

• Load one preset object by name (user root first), or null if unknown/invalid.

Source:

• engine/presets.js, line 43

Parameters:

Returns:

Type

object | null

logicalListNames(physical) → {Array.<string>}

Description:

• Turn the physical on-disk names into the LOGICAL reference set, the names the rest of the app sees. A mixed list is stored as two files, <base>-sfw and <base>-nsfw, with NO <base> file — the bare {base} is implicit, and this exposes all three references (base, base-sfw, base-nsfw). A standalone <base>-nsfw with no <base>-sfw counterpart is exposed only by its gated -nsfw name (NSFW-only).

  Safety rule: a plain <p> file is only a normal SFW list when it has NO <p>-nsfw sibling; if such a sibling exists the plain file is IGNORED (not exposed, not loaded), to force the explicit -sfw/-nsfw split. Only <base>-sfw counts as an SFW source — a stray <base> next to <base>-nsfw does not.

Source:

• engine/nameOrder.js, line 121

Parameters:

Returns:

Type

Array.<string>

makeListStage(store) → {function}

Description:

• Build the {name} list stage bound to a list store (loader-injected port).

Source:

• engine/core/stages/list.js, line 20

Parameters:

Returns:

Type

function

materializeTemplate(template) → {string}

Description:

• Strip an editor template down to plain text — ${1:foo} → foo, ${sel} → nothing.

  Needed by any target without a snippet-aware editor (the mobile app has a plain TextInput, not CodeMirror), so it inserts the concrete text instead of the tab-stop form.

Source:

• engine/dplInsertCatalog.js, line 202

Parameters:

Returns:

Type

string

mergeNew(pool, candidates) → {Array.<string>}

Description:

• The candidates not already present in pool (case-insensitive), de-duplicated against each other, in their original order.

Source:

• engine/listEditorOps.js, line 42

Parameters:

Returns:

Type

Array.<string>

module:gui/App() → {JSX.Element}

Description:

• The application root: owns settings and establishes the i18n boundary so the whole shell (and its localized strings) renders under a configured provider.

Source:

• tmp/webapp-docs/frontend/App.js, line 171

Returns:

Type

JSX.Element

module:gui/components/ApiKeyField(props) → {JSX.Element|null}

Description:

• A provider's API-key field.

Source:

• tmp/webapp-docs/frontend/components/ApiKeyField.js, line 92

Parameters:

Returns:

Type

JSX.Element | null

module:gui/components/DialogHost() → {JSX.Element|null}

Description:

• The dialog host. Takes no props; reads the active dialog from the lib/dialog.js store.

Source:

• tmp/webapp-docs/frontend/components/DialogHost.js, line 41

Returns:

Type

JSX.Element | null

module:gui/components/DplInsertBar(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/DplInsertBar.js, line 273

Parameters:

Returns:

Type

JSX.Element

module:gui/components/DplRefineBar(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/DplRefineBar.js, line 64

Parameters:

Returns:

Type

JSX.Element

module:gui/components/DplStatus(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/DplStatus.js, line 37

Parameters:

Returns:

Type

JSX.Element

module:gui/components/Gallery(props) → {JSX.Element}

Description:

• The photo gallery grid (virtualized).

Source:

• tmp/webapp-docs/frontend/components/Gallery.js, line 247

Parameters:

Returns:

Type

JSX.Element

module:gui/components/Home(props) → {JSX.Element}

Description:

• The compose workspace.

Source:

• tmp/webapp-docs/frontend/components/Home.js, line 72

Parameters:

Returns:

Type

JSX.Element

module:gui/components/InlineImageControls(props) → {JSX.Element|null}

Description:

• Inline provider image controls (Images + Size).

Source:

• tmp/webapp-docs/frontend/components/InlineImageControls.js, line 70

Parameters:

Returns:

Type

JSX.Element | null

module:gui/components/LinksMenu() → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/LinksMenu.js, line 126

Returns:

Type

JSX.Element

module:gui/components/LivePreview(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/LivePreview.js, line 49

Parameters:

Returns:

Type

JSX.Element

module:gui/components/Manage(props) → {JSX.Element}

Description:

• The Manage workspace.

Source:

• tmp/webapp-docs/frontend/components/Manage.js, line 173

Parameters:

Returns:

Type

JSX.Element

module:gui/components/ManageBlockEditor(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/ManageBlockEditor.js, line 145

Parameters:

Returns:

Type

JSX.Element

module:gui/components/ManageFolderEditor(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/ManageFolderEditor.js, line 114

Parameters:

Returns:

Type

JSX.Element

module:gui/components/ManageListEditor(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/ManageListEditor.js, line 37

Parameters:

Returns:

Type

JSX.Element

module:gui/components/NsfwToggle(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/NsfwToggle.js, line 59

Parameters:

Returns:

Type

JSX.Element

module:gui/components/ProviderBox(props) → {JSX.Element|null}

Description:

• The provider's own controls (rendered inside the header gear popover).

Source:

• tmp/webapp-docs/frontend/components/ProviderBox.js, line 103

Parameters:

Returns:

Type

JSX.Element | null

module:gui/components/ProviderGear(props) → {JSX.Element|null}

Source:

• tmp/webapp-docs/frontend/components/ProviderGear.js, line 157

Parameters:

Returns:

Type

JSX.Element | null

module:gui/components/ProviderPicker(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/ProviderPicker.js, line 45

Parameters:

Returns:

Type

JSX.Element

module:gui/components/ProvidersMenu(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/ProvidersMenu.js, line 119

Parameters:

Returns:

Type

JSX.Element

module:gui/components/Settings(props) → {JSX.Element}

Description:

• The prompt-knobs form.

Source:

• tmp/webapp-docs/frontend/components/Settings.js, line 145

Parameters:

Returns:

Type

JSX.Element

module:gui/components/SettingsDrawer(props) → {JSX.Element|null}

Source:

• tmp/webapp-docs/frontend/components/SettingsDrawer.js, line 30

Parameters:

Returns:

Type

JSX.Element | null

module:gui/components/SingleView(props) → {JSX.Element}

Description:

• The single-image view.

Source:

• tmp/webapp-docs/frontend/components/SingleView.js, line 78

Parameters:

Returns:

Type

JSX.Element

module:gui/components/ThemePicker() → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/ThemePicker.js, line 70

Returns:

Type

JSX.Element

module:gui/components/TokenPicker(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/TokenPicker.js, line 34

Parameters:

Returns:

Type

JSX.Element

module:gui/components/UpdateBanner() → {JSX.Element|null}

Source:

• tmp/webapp-docs/frontend/components/UpdateBanner.js, line 63

Returns:

Type

JSX.Element | null

module:gui/components/WrapperFab(props) → {JSX.Element}

Source:

• tmp/webapp-docs/frontend/components/WrapperFab.js, line 195

Parameters:

Returns:

Type

JSX.Element

module:gui/components/home/BlockPalette(props) → {JSX.Element}

Description:

• The building-block palette.

Source:

• tmp/webapp-docs/frontend/components/home/BlockPalette.js, line 51

Parameters:

Returns:

Type

JSX.Element

module:gui/components/manage/ManageDetail(props) → {JSX.Element}

Description:

• The right-pane detail/preview for the current selection.

Source:

• tmp/webapp-docs/frontend/components/manage/ManageDetail.js, line 95

Parameters:

Returns:

Type

JSX.Element

module:gui/components/single/DerivedStrips(props) → {JSX.Element|null}

Description:

• The derived-children grid.

Source:

• tmp/webapp-docs/frontend/components/single/DerivedStrips.js, line 37

Parameters:

Returns:

Type

JSX.Element | null

module:gui/components/single/DetailTable()

Description:

• A <table> of label/value detail rows (empty rows skipped).

Source:

• tmp/webapp-docs/frontend/components/single/DetailTable.js, line 27

module:gui/components/single/PromptCard()

Description:

• The prompt (or negative) card: its layers, most-relevant first, dupes collapsed.

Source:

• tmp/webapp-docs/frontend/components/single/PromptCard.js, line 57

module:gui/i18n/I18nProvider(props) → {JSX.Element}

Description:

• Wrap the app subtree in a configured <IntlProvider>.

Source:

• tmp/webapp-docs/frontend/i18n/I18nProvider.js, line 34

Parameters:

Returns:

Type

JSX.Element

normalize(line) → {string}

Description:

• Normalize a raw list line to a lowercase, single-spaced token string.

Source:

• engine/contentSafety.js, line 57

Parameters:

Returns:

Type

string

parseAiCandidates(out) → {Array.<string>}

Description:

• Parse an AI "expand" reply into clean candidate entries — one per line, tolerating a stray - / 1. / • list prefix; falls back to comma-separated when the reply is a single line.

Source:

• engine/listEditorOps.js, line 22

Parameters:

Returns:

Type

Array.<string>

parseArgs(blob) → {Object}

Description:

• Parse the optional dial-argument blob after a {#name …} token into { intensity, focus }. Args are i/f-prefixed percents ({#name i25% f80%}); the prefix is mandatory (an unprefixed NN% never reaches here — the resolver regex only matches prefixed args).

Source:

• engine/core/stages/block.js, line 48

Parameters:

Returns:

Type

Object

parseBracketSpec()

Description:

• Parse the inside of a leading […] bracket into { weight?, iCond?, fCond? }, or null when it is not a weight/condition spec (so [[castle]], [deemph], [a:b:0.5], the salt literal pass through as payload). A weight is bare digits; a condition is [if] OP NN% — the dial prefix i (intensity) or f (focus) is MANDATORY (the two look-alike percents must be disambiguated; an unprefixed OP NN% is not a condition and leaves the bracket as payload). A bracket may stack a weight and one i-condition and one f-condition, separated by a pipe or whitespace, in any order: [100 i<10% f<40%], [f<40%|100].

Source:

• engine/core/dpl/parser.js, line 17

parseChoice()

Description:

• Parse a one of / N of / A to B of choice (optional (NN% nothing) miss) onto out. Returns true when a choice was recorded (the node is then complete).

Source:

• engine/core/dpl/parser.js, line 226

parseFlow()

Description:

• Flow directive at the head of a line (go back / go to X), or null.

Source:

• engine/core/dpl/parser.js, line 183

parseFrontMatter(source) → {Object}

Description:

• Split a leading --- YAML-ish front-matter block from the body.

Source:

• engine/core/dpl/parser.js, line 66

Parameters:

Returns:

Type

Object

parseGate()

Description:

• Parse a leading gate (otherwise, NN%, maybe, NN% chance) onto out, returning the remaining text. scaleGate marks a probability gate (intensity auto-scales it); a bare otherwise keeps an unscaled gate of 1 (it runs whenever the paired gate failed).

Source:

• engine/core/dpl/parser.js, line 195

parseNode(node) → {object}

Description:

• Parse one tree node's text into a typed descriptor (weight/gate/repeat/choice/ref/payload).

Source:

• engine/core/dpl/parser.js, line 269

Parameters:

Returns:

Type

object

parseRef()

Description:

• Parse a reference form (insert js: path / insert name / +name) onto out.

Source:

• engine/core/dpl/parser.js, line 255

parseRepeat()

Description:

• Parse a repeat N times / repeat A to B times prefix onto out, returning the remaining text.

Source:

• engine/core/dpl/parser.js, line 244

parseSections(lines) → {object}

Description:

• Parse the lexed lines into { sectionName: nodeTree }. A heading is a text line whose next line is ={3,}; Start is the entry section. Lines under a heading nest by depth.

Source:

• engine/core/dpl/parser.js, line 120

Parameters:

Returns:

Type

object

pickerListNames() → {Array.<string>}

Description:

• The list names to show in the web picker, honoring adult mode. When adult is off, every name carrying an nsfw token is hidden (the app behaves as if it doesn't exist). When on, each base that has a <base>-nsfw sibling also offers the explicit <base>-sfw reference, so the picker shows all three (default / SFW-only / NSFW).

Source:

• engine/promptFilesAndSuggestions.js, line 156

Returns:

Type

Array.<string>

pickerLists() → {Array.<string>}

Description:

• The picker-facing list names (honouring the current adult flag).

Source:

• engine/nodeEngine.js, line 84

Returns:

Type

Array.<string>

presetNames() → {Array.<string>}

Description:

• Every available preset name (union of both roots), sorted.

Source:

• engine/presets.js, line 24

Returns:

Type

Array.<string>

processMdj(settings, lessEmphasis, keyword) → {string}

Description:

• Midjourney emphasis: append ::factor, factor = 1.05·N up (or its reciprocal down); N is rolled by emphasisLevelChance up to emphasisMaxLevels.

Source:

• engine/helpers/randomEmphasis.js, line 73

Parameters:

Returns:

Type

string

processNAI(settings, lessEmphasis, keyword) → {string}

Description:

• NovelAI emphasis: same nested-bracket leveling as SD (the list stage later rewrites () to {} for NovelAI).

Source:

• engine/helpers/randomEmphasis.js, line 59

Parameters:

Returns:

Type

string

processPlain(settings, lessEmphasis, keyword) → {string}

Description:

• Plain (natural-language) emphasis: roll a level like the other dialects, then prefix the keyword with an intensifier (emphasis) or hedge (de-emphasis) word from the ladder — keeping the emphasis the engine rolled instead of dropping it for syntax-less targets.

Source:

• engine/helpers/randomEmphasis.js, line 114

Parameters:

Returns:

Type

string

processRepeat(count, keyword, alias) → {string}

Description:

• Build a comma-joined run of count list tokens.

Source:

• engine/helpers/keywordRepeater.js, line 37

Parameters:

Returns:

Type

string

processSd(settings, lessEmphasis, keyword) → {string}

Description:

• StableDiffusion emphasis: wrap the keyword in N nested () (emphasis) or [] (de-emphasis); N is rolled by emphasisLevelChance up to emphasisMaxLevels.

Source:

• engine/helpers/randomEmphasis.js, line 32

Parameters:

Returns:

Type

string

promptSuggestion(fullopt) → {string}

Description:

• Build a random prompt suggestion (the engine behind #random): one to three full blocks, sometimes AND-weighted, with optional garnish, then cleaned up.

Source:

• engine/promptFilesAndSuggestions.js, line 222

Parameters:

Returns:

Type

string

pushUnique(out, seenLine, lines)

Description:

• Append the \r-stripped, non-empty, not-yet-seen lines from lines onto out.

Source:

• engine/listResolve.js, line 95

Parameters:

randomFloat()

Description:

• A uniform float in [0, 1) from the ambient source — the probability-roll primitive.

Source:

• engine/helpers/random.js, line 64

randomInt()

Description:

• A uniform integer in [min, max] inclusive; order-tolerant.

Source:

• engine/helpers/random.js, line 70

randomSeed()

Description:

• A fresh, unpredictable seed string (crypto if available, else time + Math.random).

Source:

• engine/core/rng.js, line 76

readAmbient()

Source:

• engine/helpers/random.js, line 30

Returns:

readSfwBase(base, readers) → {Array.<string>|null}

Description:

• Read a plain list's SFW base lines. Safety rule: when a <base>-nsfw sibling exists, a plain <base>.txt is IGNORED — the SFW source must be the explicit <base>-sfw.txt. This enforces the naming split so a stray <base>.txt can never leak as SFW alongside NSFW (a lone <base>.txt beside <base>-nsfw.txt is thus treated as NSFW-only). With no <base>-nsfw sibling, a plain <base>.txt is a normal SFW list (with <base>-sfw.txt as a fallback). Returns null when no SFW source exists, else an array (possibly empty).

Source:

• engine/listResolve.js, line 29

Parameters:

Returns:

Type

Array.<string> | null

renderChoice()

Description:

• Choice: pick 1..N options (weighted by each option's leading %), honoring a miss chance. The pick count is scaled by intensity, so low intensity yields fewer (possibly zero) picks.

Source:

• engine/core/dpl/renderer.js, line 120

renderEmphasis(mode, phrase, depth, lessEmphasis) → {string}

Description:

• Render one emphasis group into the active dialect.

Source:

• engine/core/stages/emphasis.js, line 53

Parameters:

Returns:

Type

string

renderInlineBody()

Description:

• Render the payload text of a node, substituting inline {js:path} via the bridge.

Source:

• engine/core/dpl/renderer.js, line 175

renderRef()

Description:

• Resolve a reference node (call/insert/js-block) to a string.

Source:

• engine/core/dpl/renderer.js, line 224

renderRepeat()

Description:

• Repeat: loop count times, rendering the body (payload or child block) each time. The count is scaled by intensity (round(n × intensity/100)), so the dial thins/thickens repetition.

Source:

• engine/core/dpl/renderer.js, line 139

requireLoader() → {object}

Source:

• engine/promptFilesAndSuggestions.js, line 61

Throws:

If configure() has not been called.

Type

Error

Returns:

Type

object

resolveGroup() → {Array.<string>}

Description:

• A group (real .group file or implied-group folder): the de-duplicated union of its members' lines, propagating the resolved variant, with the depth + cycle guard.

Source:

• engine/listResolve.js, line 152

Returns:

Type

Array.<string>

resolveListLines(name, readers, includeAdultopt, forcedopt, depthopt, seenopt) → {Array.<string>|null}

Description:

• Resolve a list/group reference to its lines, honoring the SFW/NSFW naming model and the includeAdult mode. No runtime content filtering — NSFW is a separate preprocessed <base>-nsfw.txt file that is simply included or not.

  Semantics (per reference):

  • {name} → SFW only when adult is off; SFW + <name>-nsfw when on.
  • {name-sfw} → SFW base only (always; the explicit SFW-exclusive reference).
  • {name-nsfw} → nothing when adult is off (acts as if it doesn't exist); SFW + <name>-nsfw when on (the SFW base is auto-tacked on).

  Groups propagate the resolved variant to their members, so {d} (off) is all-SFW, {d} (on) includes NSFW, and {d-sfw} is SFW even when on.

Source:

• engine/listResolve.js, line 192

Parameters:

Returns:

Type

Array.<string> | null

resolveName(ref, names) → {string}

Description:

• Resolve a list reference to a canonical list name by PATH-SUFFIX matching, so a prompt can use a bare filename (general), a partial path (danbooru/general), or a full path — and folders can be nested arbitrarily deep. An exact match wins; otherwise any name whose path ends with /<ref> matches, and the shallowest (fewest folders), then alphabetically-first, match is chosen for determinism.

Source:

• engine/nameOrder.js, line 156

Parameters:

Returns:

Type

string

resolvePresets(spec) → {Array.<object>}

Description:

• Resolve a comma/space-separated preset list into preset objects, in order. Unknown names throw so a typo surfaces rather than silently doing nothing.

Source:

• engine/presets.js, line 66

Parameters:

Throws:

If a named preset doesn't exist.

Type

Error

Returns:

Type

Array.<object>

resolveVariant() → {Object|Object}

Description:

• Resolve a reference's base name + variant ("sfw" = SFW only, "full" = SFW+NSFW). An explicit -nsfw reference is excluded (invisible) when adult is off or a parent forces SFW.

Source:

• engine/listResolve.js, line 109

Returns:

Type

Object | Object

resolveWildcard() → {Array.<string>}

Description:

• Reserved keyword wildcard: the union of ALL general vocabulary (mode-aware), excluding the artist/* and danbooru/* namespaces, groups (covered via their lists), and itself.

Source:

• engine/listResolve.js, line 125

Returns:

Type

Array.<string>

sample()

Description:

• A uniformly random element of arr (undefined for an empty array).

Source:

• engine/helpers/random.js, line 76

scaleCount()

Description:

• Scale an authored count by intensity: round(n × intensity/100), never below 0.

Source:

• engine/core/dpl/intensity.js, line 39

scanDigits() → {number}

Source:

• engine/nameOrder.js, line 48

Returns:

Type

number

seedFor(settings, explicitSeedopt) → {string|undefined}

Description:

• Which seed (if any) the engine should use for this call. The rule is explicit — there are NO magic seed values:

  1. explicitSeed (when given) always wins. The batch roll uses this to fork one base seed into a distinct-but-reproducible sub-seed per prompt.
  2. Otherwise, when randomSeed is OFF, the run is pinned to promptSeed verbatim (any integer, including 0 and negatives, is honoured).
  3. Otherwise (random on, the default) → undefined: the engine stays unseeded and rerolls fresh. The image-provider seed is NEVER used here — that's a different field.

Source:

• engine/promptRun.js, line 30

Parameters:

Returns:

Type

string | undefined

setActiveSettings(settings) → {void}

Description:

• Set the settings the suggestion builder / cleanup should read for gating (notably includeAdult). Call before generating so NSFW gating honours the run's settings.

Source:

• engine/nodeEngine.js, line 30

Parameters:

Returns:

Type

void

setAmbientRng(rng)

Source:

• engine/helpers/random.js, line 54

Parameters:

setMetroOverlay(next)

Description:

• Replace the runtime user overlay and invalidate the loader caches. Call with empty/omitted maps to clear it (restoring the pure built-in catalog).

Source:

• engine/core/metroLoader.js, line 67

Parameters:

sfc32(a, b, c, d)

Description:

• sfc32 — Small Fast Counter, a 128-bit-state PRNG returning floats in [0, 1). Public-domain (PractRand-tested). Not cryptographic — it's for reproducible content generation.

Source:

• engine/core/rng.js, line 58

Parameters:

Returns:

shuffle()

Description:

• A new array with arr's elements in uniformly random order (Fisher–Yates).

Source:

• engine/helpers/random.js, line 81

sortLines(lines) → {Array.<string>}

Description:

• Sort entries alphabetically (case-insensitive, locale-aware). Non-mutating.

Source:

• engine/listEditorOps.js, line 76

Parameters:

Returns:

Type

Array.<string>

swapOut(settings, keyword) → {string}

Description:

• Prompt-editing "swap": [kw:kw:n] — re-assert the keyword at step n.

Source:

• engine/helpers/randomEditing.js, line 40

Parameters:

Returns:

Type

string

weightFor()

Description:

• A dialect weight number for an intensity (50 = ×1.0): trimmed to ≤2 decimals, no trailing zeros.

Source:

• engine/core/stages/emphasis.js, line 41

weightOf()

Description:

• A node's explicit weight, or null (used for refs that carry a weight).

Source:

• engine/core/dpl/renderer.js, line 236

weightedSampleN(opts, n, rng) → {Array}

Description:

• Pick n distinct options weighted by each option's leading gate %, else uniform. Draws from the render context's rng (ctx.rng) so the pick is part of the seeded stream — not Math.random.

Source:

• engine/core/dpl/renderer.js, line 248

Parameters:

Returns:

Type

Array

withAmbientRng(rng, fn) → {T}

Description:

• Install rng as the ambient source for the duration of fn, restoring the previous source afterward (even if fn throws). Nestable. This is how the engine scopes a seeded stream to a single generation.

Source:

• engine/helpers/random.js, line 43

Parameters:

Returns:

Type

T