Klai Utility Functions

BetterForm has a collection of helper Java Script functions that are used within JavaScript to allow easy access to common complex code.

Function	Description
Actions
BF.actionsClear()	Clears the action script buffer halting all subsequent actions (current action completes)
Errors
BF.errorClearAll()	Clears the error cache
BF.errorGetAll()	Returns all current errors
BF.errorThrow(errorCode, errorDescription, info)	Creates an error
BF.authGetLastFeedback()	Returns the latest authentication feedback object from store.state.auth.lastFeedback. Useful for reading the latest auth code, message, type, and numericCode (for error flows).
Actions
BF.namedAction(name, options)	Runs a named action, options are propagated to all actions within the named action.
Misc
BF.getPaths(object, JPquery)	Returns JSONPath query on passed object
BF.getQueryParam(key)	Returns the URL query key value
BF.i18n(key)	Internationalization translations. Returns the key's value in its correct language.
BF.getUUID()	Returns a UUID
BF.pwaSetManifest(manifest)	Sets the manifest for PWA apps. manifest is a JSON object that confirms to a standard PWA manifest object.
BF.getVersion()	Returns an object with version info: { basecode, app }. basecode is the Klai operating system version. app is the published app version (from the evironments card if present, otherwise falls back to site.hash). Available in basecode v3.2.19+.
BF.rebuildReactivity(object)	This function is normally run upon the completion of a function internally by the Klai actions processor. It recursively scans the object passed and adds new reactive keys to keys that are new or do not have reactivity. You will not need to use this within a function unless that function has a callback that later mutates a reactive object. Eg: setTimeout() which takes a callback.
BF.socketConnect()	Connects the client to the Klai server via a socket
BF.socketDisconnect()	Disconnects the client from the Klai servers (Goes off line)
Dynamic Library Loading
BF.libraryLoadOnce(url, options)	Load external JavaScript libraries, ESM modules, and CSS files from CDN dynamically. Libraries are loaded once and cached automatically (idempotent). Available in basecode v3.2.31+.
BF.libraryIsLoaded(url)	Check if a library is already loaded. Returns boolean. Available in basecode v3.2.31+.
BF.libraryGetLoaded()	Get array of all loaded library URLs. Available in basecode v3.2.31+.

Dynamic Library Loading

For detailed documentation on the dynamic library loading functions (BF.libraryLoadOnce, BF.libraryIsLoaded, BF.libraryGetLoaded), see:

Dynamic Library Loading

Auth Feedback Helper

BF.authGetLastFeedback()

Returns the latest auth feedback object written by BetterForms authentication flows.

Example return values:

{
  code: "auth.magic_link_sent",
  message: "If that email can be used to sign in, a magic link has been sent.",
  type: "info"
}

{
  code: "auth.invalid_login",
  message: "We couldn't sign you in. Check your details and try again.",
  type: "error",
  numericCode: 10150
}

Typical usage:

const feedback = BF.authGetLastFeedback();

if (feedback && feedback.code === "auth.invalid_login") {
  console.log(feedback.message);
}

Notes:

• This is a read helper only.

• The value mirrors store.state.auth.lastFeedback.

• For page UI, you can also read model.authMessage, model.authMessageCode, and model.authMessageType.